##// END OF EJS Templates
implab » implabjs-dojo-typings
RSS
updated _WidgetBase typings, added support for the generic type parameter to the constructor
cin -
r1:d55cc09feba1 default
parent child
Show More
Show file before | Show file after | Hide comments
@@ -0,0 +1,17
1 import _WidgetBase = require("dijit/_WidgetBase");
2
3 interface ScheduleWidgetAttrs {
4 data: string[];
5 }
6
7 declare const w0: _WidgetBase<ScheduleWidgetAttrs>;
8
9 w0.get("data");
10
11 declare class ScheduleWidget extends _WidgetBase {
12 data: string[];
13 }
14
15 const w = new ScheduleWidget({title: "Year schedule", data: ["a", "b"] });
16
17 w.get("data"); No newline at end of file
Show file before | Show file after | Hide comments
@@ -1,59 +1,60
1 1 import org.gradle.internal.os.OperatingSystem;
2 2
3 3 plugins {
4 4 id "org.implab.gradle-typescript" version "1.3.4"
5 5 }
6 6
7 7 def isWindows = OperatingSystem.current().isWindows();
8 8
9 9 npm {
10 10 npmCmd = isWindows ? 'npm.cmd' : 'npm';
11 11 }
12 12
13 13 sources {
14 14 main { me ->
15 15 ts {
16 // to check typings with the compiler
16 17 srcDir me.typings
17 18 }
18 19 }
19 20 }
20 21
21 22 typescript {
22 23 compilerOptions {
23 24 lib = ["es5", "dom", "scripthost", "es2015.promise", "es2015.symbol", "es2015.iterable"]
24 25 declaration = true
25 26 types = ["requirejs"]
26 27 module = "amd"
27 28 it.target = "es5"
28 29 moduleResolution = "node"
29 30 // traceResolution = true
30 31
31 32 }
32 33
33 34 // для варианта с локальными tsc, eslint, tslint
34 35 tscCmd = "${projectDir}/node_modules/.bin/" + (isWindows ? 'tsc.cmd' : 'tsc')
35 36 esLintCmd = "${projectDir}/node_modules/.bin/" + (isWindows ? 'eslint.cmd' : 'eslint')
36 37 tsLintCmd = "${projectDir}/node_modules/.bin/" + (isWindows ? 'tslint.cmd' : 'tslint')
37 38 }
38 39
39 40 configureTsTest {
40 41 compilerOptions {
41 42 types = ["../main/typings/dojo/modules","../main/typings/dijit/modules"];
42 43 }
43 44 }
44 45
45 46 npmPackMeta {
46 47 meta {
47 48 name = "@$npmScope/$project.name"
48 49 }
49 50 }
50 51
51 52 task printVersion {
52 53 doLast {
53 54 println "packageName: ${npmPackMeta.metadata.get().name}";
54 55 println "version: $version";
55 56 println "target: $typescript.compilerOptions.target";
56 57 println "module: $typescript.compilerOptions.module";
57 58 println "symbols: $symbols";
58 59 }
59 60 } No newline at end of file
Show file before | Show file after | Hide comments
@@ -1,2303 +1,2303
1 1 /// <reference path="../dojo/index.d.ts" />
2 2 /// <reference path="form.d.ts" />
3 3 /// <reference path="layout.d.ts" />
4 4
5 5 declare namespace dijit {
6 6 /* Global Dijit Interface */
7 7 interface Dijit { }
8 8
9 9 /* dijit/_AttachMixin */
10 10
11 11 /* tslint:disable:class-name */
12 12
13 13 interface _WidgetBase {
14 14 dojoAttachEvent: string;
15 15 dojoAttachPoint: string;
16 16 }
17 17
18 18 interface _AttachMixin {
19 19 /**
20 20 * List of widget attribute names associated with data-dojo-attach-point=... in the template, ex: ["containerNode", "labelNode"]
21 21 */
22 22 _attachPoints: string[];
23 23
24 24 /**
25 25 * List of connections associated with data-dojo-attach-event=... in the template
26 26 */
27 27 _attachEvents: dojo.Handle[];
28 28
29 29 /**
30 30 * Object to which attach points and events will be scoped. Defaults to 'this'.
31 31 */
32 32 attachScope: any;
33 33
34 34 /**
35 35 * Search descendants of this.containerNode for data-dojo-attach-point and data-dojo-attach-event.
36 36 *
37 37 * Should generally be left false (the default value) both for performance and to avoid failures when this.containerNode holds other _AttachMixin instances with their own attach points and events.
38 38 */
39 39 searchContainerNode: boolean;
40 40
41 41 /**
42 42 * Attach to DOM nodes marked with special attributes.
43 43 */
44 44 buildRendering(): void;
45 45
46 46 /**
47 47 * hook for _WidgetsInTemplateMixin
48 48 */
49 49 _beforeFillContent(): void;
50 50
51 51 /**
52 52 * Iterate through the dom nodes and attach functions and nodes accordingly.
53 53 *
54 54 * Map widget properties and functions to the handlers specified in the dom node and it's descendants. This function iterates over all nodes and looks for these properties:
55 55 * - dojoAttachPoint/data-dojo-attach-point
56 56 * - dojoAttachEvent/data-dojo-attach-event
57 57 */
58 58 _attachTemplateNodes(rootNode: Element | Node): void;
59 59
60 60 /**
61 61 * Process data-dojo-attach-point and data-dojo-attach-event for given node or widget.
62 62 *
63 63 * Returns true if caller should process baseNode's children too.
64 64 */
65 65 _processTemplateNode<T extends (Element | Node | _WidgetBase)>(
66 66 baseNode: T,
67 67 getAttrFunc: (baseNode: T, attr: string) => string,
68 68 attachFunc: (node: T, type: string, func?: Function) => dojo.Handle
69 69 ): boolean;
70 70
71 71 /**
72 72 * Roughly corresponding to dojo/on, this is the default function for processing a data-dojo-attach-event. Meant to attach to DOMNodes, not to widgets.
73 73 */
74 74 _attach(node: Element | Node, type: string, func?: Function): dojo.Handle;
75 75
76 76 /**
77 77 * Detach and clean up the attachments made in _attachtempalteNodes.
78 78 */
79 79 _detachTemplateNodes(): void;
80 80
81 81 destroyRendering(preserveDom?: boolean): void;
82 82 }
83 83
84 84 interface _AttachMixinConstructor extends dojo._base.DeclareConstructor<_AttachMixin> { }
85 85
86 86 /* dijit/_BidiMixin */
87 87
88 88 interface _WidgetBase {
89 89
90 90 /**
91 91 * Gets the right direction of text.
92 92 */
93 93 getTextDir(text: string): string;
94 94
95 95 /**
96 96 * Set element.dir according to this.textDir, assuming this.textDir has a value.
97 97 */
98 98 applyTextDir(element: HTMLElement, text?: string): void;
99 99
100 100 /**
101 101 * Wraps by UCC (Unicode control characters) option's text according to this.textDir
102 102 */
103 103 enforceTextDirWithUcc(option: HTMLOptionElement, text: string): string;
104 104
105 105 /**
106 106 * Restores the text of origObj, if needed, after enforceTextDirWithUcc, e.g. set("textDir", textDir).
107 107 */
108 108 restoreOriginalText(origObj: HTMLOptionElement): HTMLOptionElement;
109 109 }
110 110
111 111 /* dijit/_ConfirmDialogMixin */
112 112
113 113 interface _ConfirmDialogMixin extends _WidgetsInTemplateMixin {
114 114 /**
115 115 * HTML snippet for action bar, overrides _DialogMixin.actionBarTemplate
116 116 */
117 117 actionBarTemplate: string;
118 118
119 119 /**
120 120 * Label of OK button.
121 121 */
122 122 buttonOk: string;
123 123
124 124 /**
125 125 * Label of cancel button.
126 126 */
127 127 buttonCancel: string;
128 128 }
129 129
130 130 /* dijit/_Contained */
131 131
132 132 interface _Contained {
133 133 /**
134 134 * Returns the previous child of the parent or null if this is the
135 135 * first child of the parent.
136 136 */
137 137 getPreviousSibling<T extends _WidgetBase>(): T;
138 138
139 139 /**
140 140 * Returns the next child of the parent or null if this is the last
141 141 * child of the parent.
142 142 */
143 143 getNextSibling<T extends _WidgetBase>(): T;
144 144
145 145 /**
146 146 * Returns the index of this widget within its container parent.
147 147 * It returns -1 if the parent does not exist or if the parent is
148 148 * not a dijit/_Container.
149 149 */
150 150 getIndexInParent(): number;
151 151 }
152 152
153 153 interface _ContainedConstructor extends dojo._base.DeclareConstructor<_Contained> { }
154 154
155 155 /* dijit/_Container */
156 156
157 157 interface _Container {
158 158 buildRendering(): void;
159 159
160 160 /**
161 161 * Makes the given widget a child of this widget.
162 162 */
163 163 addChild<T extends _WidgetBase>(widget: T, insertIndex?: number): void;
164 164
165 165 /**
166 166 * Removes the passed widget instance from this widget but does
167 167 * not destroy it. You can also pass in an integer indicating
168 168 * the index within the container to remove (ie, removeChild(5) removes the sixth widget)
169 169 */
170 170 removeChild<T extends _WidgetBase>(widget: T): void;
171 171 removeChild<T extends number>(widget: number): void;
172 172
173 173 /**
174 174 * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets.
175 175 */
176 176 hasChildren(): boolean;
177 177
178 178 /**
179 179 * Gets the index of the child in this container or -1 if not found
180 180 */
181 181 getIndexOfChild<T extends _WidgetBase>(widget: T): number;
182 182 }
183 183
184 184 interface _ContainerConstructor extends dojo._base.DeclareConstructor<_Container> { }
185 185
186 186 /* dijit/_CssStateMixin */
187 187
188 188 interface CSSStateNodes {
189 189 [node: string]: string;
190 190 }
191 191
192 192 interface _CssStateMixin {
193 193 /**
194 194 * True if cursor is over this widget
195 195 */
196 196 hovering: boolean;
197 197
198 198 /**
199 199 * True if mouse was pressed while over this widget, and hasn't been released yet
200 200 */
201 201 active: boolean;
202 202 }
203 203
204 204 interface _CssStateMixinConstructor extends dojo._base.DeclareConstructor<_CssStateMixin> { }
205 205
206 206 /* dijit/_DialogMixin */
207 207
208 208 interface _DialogMixin {
209 209 /**
210 210 * HTML snippet to show the action bar (gray bar with OK/cancel buttons).
211 211 * Blank by default, but used by ConfirmDialog/ConfirmTooltipDialog subclasses.
212 212 */
213 213 actionBarTemplate: string;
214 214
215 215 /**
216 216 * Callback when the user hits the submit button.
217 217 * Override this method to handle Dialog execution.
218 218 */
219 219 execute(formContents?: any): void;
220 220
221 221 /**
222 222 * Called when user has pressed the Dialog's cancel button, to notify container.
223 223 */
224 224 onCancel(): void;
225 225
226 226 /**
227 227 * Called when user has pressed the dialog's OK button, to notify container.
228 228 */
229 229 onExecute(): void;
230 230 }
231 231
232 232 /* dijit/_FocusMixin */
233 233 interface _FocusMixin { }
234 234
235 235 interface _WidgetBase {
236 236 /**
237 237 * Called when the widget becomes "active" because
238 238 * it or a widget inside of it either has focus, or has recently
239 239 * been clicked.
240 240 */
241 241 onFocus(): void;
242 242
243 243 /**
244 244 * Called when the widget stops being "active" because
245 245 * focus moved to something outside of it, or the user
246 246 * clicked somewhere outside of it, or the widget was
247 247 * hidden.
248 248 */
249 249 onBlur(): void;
250 250 }
251 251
252 252 /* dijit/_HasDropDown */
253 253
254 254 interface _HasDropDown<T extends _WidgetBase> extends _FocusMixin {
255 255 /**
256 256 * The button/icon/node to click to display the drop down.
257 257 * Can be set via a data-dojo-attach-point assignment.
258 258 * If missing, then either focusNode or domNode (if focusNode is also missing) will be used.
259 259 */
260 260 _buttonNode: HTMLElement;
261 261
262 262 /**
263 263 * Will set CSS class dijitUpArrow, dijitDownArrow, dijitRightArrow etc. on this node depending
264 264 * on where the drop down is set to be positioned.
265 265 * Can be set via a data-dojo-attach-point assignment.
266 266 * If missing, then _buttonNode will be used.
267 267 */
268 268 _arrowWrapperNode: HTMLElement;
269 269
270 270 /**
271 271 * The node to set the aria-expanded class on.
272 272 * Also sets popupActive class but that will be removed in 2.0.
273 273 * Can be set via a data-dojo-attach-point assignment.
274 274 * If missing, then focusNode or _buttonNode (if focusNode is missing) will be used.
275 275 */
276 276 _popupStateNode: HTMLElement;
277 277
278 278 /**
279 279 * The node to display the popup around.
280 280 * Can be set via a data-dojo-attach-point assignment.
281 281 * If missing, then domNode will be used.
282 282 */
283 283 _aroundNode: HTMLElement;
284 284
285 285 /**
286 286 * The widget to display as a popup. This widget *must* be
287 287 * defined before the startup function is called.
288 288 */
289 289 dropDown: T;
290 290
291 291 /**
292 292 * Set to true to make the drop down at least as wide as this
293 293 * widget. Set to false if the drop down should just be its
294 294 * default width.
295 295 */
296 296 autoWidth: boolean;
297 297
298 298 /**
299 299 * Set to true to make the drop down exactly as wide as this
300 300 * widget. Overrides autoWidth.
301 301 */
302 302 forceWidth: boolean;
303 303
304 304 /**
305 305 * The max height for our dropdown.
306 306 * Any dropdown taller than this will have scrollbars.
307 307 * Set to 0 for no max height, or -1 to limit height to available space in viewport
308 308 */
309 309 maxHeight: number;
310 310
311 311 /**
312 312 * This variable controls the position of the drop down.
313 313 * It's an array of strings
314 314 */
315 315 dropDownPosition: string[];
316 316 /* TODO remove for TS 1.8 */
317 317 /* dropDownPosition: ('before' | 'after' | 'above' | 'below')[]; */
318 318
319 319 /**
320 320 * When set to false, the click events will not be stopped, in
321 321 * case you want to use them in your subclass
322 322 */
323 323 _stopClickEvents: boolean;
324 324
325 325 /**
326 326 * Callback when the user mousedown/touchstart on the arrow icon.
327 327 */
328 328 _onDropDownMouseDown(e: MouseEvent): void;
329 329
330 330 /**
331 331 * Callback on mouseup/touchend after mousedown/touchstart on the arrow icon.
332 332 * Note that this function is called regardless of what node the event occurred on (but only after
333 333 * a mousedown/touchstart on the arrow).
334 334 */
335 335 _onDropDownMouseUp(e?: MouseEvent): void;
336 336
337 337 /**
338 338 * The drop down was already opened on mousedown/keydown; just need to stop the event
339 339 */
340 340 _onDropDownClick(e: MouseEvent): void;
341 341
342 342 buildRendering(): void;
343 343 postCreate(): void;
344 344 destroy(preserveDom?: boolean): void;
345 345
346 346 /**
347 347 * Returns true if the dropdown exists and it's data is loaded. This can
348 348 * be overridden in order to force a call to loadDropDown().
349 349 */
350 350 isLoaded(): boolean;
351 351
352 352 /**
353 353 * Creates the drop down if it doesn't exist, loads the data
354 354 * if there's an href and it hasn't been loaded yet, and then calls
355 355 * the given callback.
356 356 */
357 357 loadDropDown(loadCallback: () => void): void;
358 358
359 359 /**
360 360 * Creates the drop down if it doesn't exist, loads the data
361 361 * if there's an href and it hasn't been loaded yet, and
362 362 * then opens the drop down. This is basically a callback when the
363 363 * user presses the down arrow button to open the drop down.
364 364 */
365 365 loadAndOpenDropDown(): dojo.Deferred<T>;
366 366
367 367 /**
368 368 * Callback when the user presses the down arrow button or presses
369 369 * the down arrow key to open/close the drop down.
370 370 * Toggle the drop-down widget; if it is up, close it, if not, open it
371 371 */
372 372 toggleDropDown(): void;
373 373
374 374 /**
375 375 * Opens the dropdown for this widget. To be called only when this.dropDown
376 376 * has been created and is ready to display (ie, it's data is loaded).
377 377 */
378 378 openDropDown(): PlaceLocation;
379 379
380 380 /**
381 381 * Closes the drop down on this widget
382 382 */
383 383 closeDropDown(focus?: boolean): void;
384 384 }
385 385
386 386 /* dijit/_OnDijitClickMixin */
387 387
388 388 interface _OnDijitClickMixin {
389 389 /**
390 390 * override _WidgetBase.connect() to make this.connect(node, "ondijitclick", ...) work
391 391 */
392 392 connect(obj: any, event: string | dojo.ExtensionEvent, method: string | dojo.EventListener): dojo.WatchHandle;
393 393 }
394 394
395 395 interface _OnDijitClickMixinConstructor {
396 396 /**
397 397 * Deprecated. New code should access the dijit/a11yclick event directly, ex:
398 398 * | this.own(on(node, a11yclick, function(){ ... }));
399 399 *
400 400 * Mixing in this class will make _WidgetBase.connect(node, "ondijitclick", ...) work.
401 401 * It also used to be necessary to make templates with ondijitclick work, but now you can just require
402 402 * dijit/a11yclick.
403 403 */
404 404 new (): _OnDijitClickMixin;
405 405 a11yclick: A11yClick;
406 406 }
407 407
408 408 /* dijit/_TemplatedMixin */
409 409
410 410 interface _TemplatedMixin extends _AttachMixin {
411 411
412 412 /**
413 413 * A string that represents the widget template.
414 414 * Use in conjunction with dojo.cache() to load from a file.
415 415 */
416 416 templateString: string;
417 417
418 418 /**
419 419 * Path to template (HTML file) for this widget relative to dojo.baseUrl.
420 420 * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead
421 421 */
422 422 templatePath: string;
423 423
424 424 /**
425 425 * Set _AttachMixin.searchContainerNode to true for back-compat for widgets that have data-dojo-attach-point's
426 426 * and events inside this.containerNode. Remove for 2.0.
427 427 */
428 428 searchContainerNode: boolean;
429 429
430 430 /**
431 431 * Construct the UI for this widget from a template, setting this.domNode.
432 432 */
433 433 buildRendering(): void;
434 434 }
435 435
436 436 interface _TemplatedMixinConstructor extends _WidgetBaseConstructor<_TemplatedMixin> {
437 437 /**
438 438 * Static method to get a template based on the templatePath or
439 439 * templateString key
440 440 */
441 441 getCachedTemplate(templateString: string, alwaysUseString: string, doc?: Document): string | HTMLElement;
442 442 }
443 443
444 444 /* dijit/_Widget */
445 445 interface _Widget extends _WidgetBase, _OnDijitClickMixin, _FocusMixin {
446 446 /**
447 447 * Connect to this function to receive notifications of mouse click events.
448 448 */
449 449 onClick(event: MouseEvent): void;
450 450
451 451 /**
452 452 * Connect to this function to receive notifications of mouse double click events.
453 453 */
454 454 onDblClick(event: MouseEvent): void;
455 455
456 456 /**
457 457 * Connect to this function to receive notifications of keys being pressed down.
458 458 */
459 459 onKeyDown(event: KeyboardEvent): void;
460 460
461 461 /**
462 462 * Connect to this function to receive notifications of printable keys being typed.
463 463 */
464 464 onKeyPress(event: KeyboardEvent): void;
465 465
466 466 /**
467 467 * Connect to this function to receive notifications of keys being released.
468 468 */
469 469 onKeyUp(event: KeyboardEvent): void;
470 470
471 471 /**
472 472 * Connect to this function to receive notifications of when the mouse button is pressed down.
473 473 */
474 474 onMouseDown(event: MouseEvent): void;
475 475
476 476 /**
477 477 * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.
478 478 */
479 479 onMouseMove(event: MouseEvent): void;
480 480
481 481 /**
482 482 * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.
483 483 */
484 484 onMouseOut(event: MouseEvent): void;
485 485
486 486 /**
487 487 * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.
488 488 */
489 489 onMouseOver(event: MouseEvent): void;
490 490
491 491 /**
492 492 * Connect to this function to receive notifications of when the mouse moves off of this widget.
493 493 */
494 494 onMouseLeave(event: MouseEvent): void;
495 495
496 496 /**
497 497 * Connect to this function to receive notifications of when the mouse moves onto this widget.
498 498 */
499 499 onMouseEnter(event: MouseEvent): void;
500 500
501 501 /**
502 502 * Connect to this function to receive notifications of when the mouse button is released.
503 503 */
504 504 onMouseUp(event: MouseEvent): void;
505 505
506 506 postCreate(): void;
507 507
508 508 /**
509 509 * Deprecated. Use set() instead.
510 510 */
511 511 setAttribute(attr: string, value: any): void;
512 512
513 513 /**
514 514 * This method is deprecated, use get() or set() directly.
515 515 */
516 516 attr(name: string | { [attr: string]: any }, value?: any): any;
517 517
518 518 /**
519 519 * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode.
520 520 */
521 521 getDescendants(): _Widget[];
522 522
523 523 /**
524 524 * Called when this widget becomes the selected pane in a
525 525 * `dijit/layout/TabContainer`, `dijit/layout/StackContainer`,
526 526 * `dijit/layout/AccordionContainer`, etc.
527 527 *
528 528 * Also called to indicate display of a `dijit.Dialog`, `dijit.TooltipDialog`, or `dijit.TitlePane`.
529 529 */
530 530 onShow(): void;
531 531
532 532 /**
533 533 * Called when another widget becomes the selected pane in a
534 534 * `dijit/layout/TabContainer`, `dijit/layout/StackContainer`,
535 535 * `dijit/layout/AccordionContainer`, etc.
536 536 *
537 537 * Also called to indicate hide of a `dijit.Dialog`, `dijit.TooltipDialog`, or `dijit.TitlePane`.
538 538 */
539 539 onHide(): void;
540 540
541 541 /**
542 542 * Called when this widget is being displayed as a popup (ex: a Calendar popped
543 543 * up from a DateTextBox), and it is hidden.
544 544 * This is called from the dijit.popup code, and should not be called directly.
545 545 *
546 546 * Also used as a parameter for children of `dijit/layout/StackContainer` or subclasses.
547 547 * Callback if a user tries to close the child. Child will be closed if this function returns true.
548 548 */
549 549 onClose(): boolean;
550 550 }
551 551
552 552 /* dijit/_WidgetBase */
553 interface _WidgetBase<Attrs = any> extends dojo.Stateful<Attrs>, Destroyable {
553 interface _WidgetBase<Attrs = any> extends dojo.Stateful<Attrs & _WidgetBase>, Destroyable {
554 554
555 555 /**
556 556 * A unique, opaque ID string that can be assigned by users or by the
557 557 * system. If the developer passes an ID which is known not to be
558 558 * unique, the specified ID is ignored and the system-generated ID is
559 559 * used instead.
560 560 */
561 561 id: string;
562 562
563 563 /**
564 564 * Rarely used. Overrides the default Dojo locale used to render this widget,
565 565 * as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute.
566 566 * Value must be among the list of locales specified during by the Dojo bootstrap,
567 567 * formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
568 568 */
569 569 lang: string;
570 570
571 571 /**
572 572 * Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir)
573 573 * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's
574 574 * default direction.
575 575 */
576 576 dir: string;
577 577
578 578 /**
579 579 * HTML class attribute
580 580 */
581 581 class: string;
582 582
583 583 /**
584 584 * HTML style attributes as cssText string or name/value hash
585 585 */
586 586 style: string;
587 587
588 588 /**
589 589 * HTML title attribute.
590 590 *
591 591 * For form widgets this specifies a tooltip to display when hovering over
592 592 * the widget (just like the native HTML title attribute).
593 593 *
594 594 * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer,
595 595 * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's
596 596 * interpreted as HTML.
597 597 */
598 598 title: string;
599 599
600 600 /**
601 601 * When this widget's title attribute is used to for a tab label, accordion pane title, etc.,
602 602 * this specifies the tooltip to appear when the mouse is hovered over that text.
603 603 */
604 604 tooltip: string;
605 605
606 606 /**
607 607 * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate
608 608 * widget state.
609 609 */
610 610 baseClass: string;
611 611
612 612 /**
613 613 * pointer to original DOM node
614 614 */
615 615 srcNodeRef: HTMLElement;
616 616
617 617 /**
618 618 * This is our visible representation of the widget! Other DOM
619 619 * Nodes may by assigned to other properties, usually through the
620 620 * template system's data-dojo-attach-point syntax, but the domNode
621 621 * property is the canonical "top level" node in widget UI.
622 622 */
623 623 domNode: HTMLElement;
624 624
625 625 /**
626 626 * Designates where children of the source DOM node will be placed.
627 627 * "Children" in this case refers to both DOM nodes and widgets.
628 628 */
629 629 containerNode: HTMLElement;
630 630
631 631 /**
632 632 * The document this widget belongs to. If not specified to constructor, will default to
633 633 * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global
634 634 */
635 635 ownerDocument: HTMLElement;
636 636
637 637 /**
638 638 * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute
639 639 * for each XXX attribute to be mapped to the DOM.
640 640 */
641 641 attributeMap: { [attribute: string]: any };
642 642
643 643 /**
644 644 * Bi-directional support, the main variable which is responsible for the direction of the text.
645 645 * The text direction can be different than the GUI direction by using this parameter in creation
646 646 * of a widget.
647 647 */
648 648 textDir: string;
649 649
650 650 /**
651 651 * Kicks off widget instantiation. See create() for details.
652 652 */
653 653 postscript(params?: any, srcNodeRef?: HTMLElement): void;
654 654
655 655 /**
656 656 * Kick off the life-cycle of a widget
657 657 */
658 658 create(params?: any, srcNodeRef?: HTMLElement): void;
659 659
660 660 /**
661 661 * Called after the parameters to the widget have been read-in,
662 662 * but before the widget template is instantiated. Especially
663 663 * useful to set properties that are referenced in the widget
664 664 * template.
665 665 */
666 666 postMixInProperties(): void;
667 667
668 668 /**
669 669 * Construct the UI for this widget, setting this.domNode.
670 670 * Most widgets will mixin `dijit._TemplatedMixin`, which implements this method.
671 671 */
672 672 buildRendering(): void;
673 673
674 674 /**
675 675 * Processing after the DOM fragment is created
676 676 */
677 677 postCreate(): void;
678 678
679 679 /**
680 680 * Processing after the DOM fragment is added to the document
681 681 */
682 682 startup(): void;
683 683
684 684 /**
685 685 * Destroy this widget and its descendants
686 686 */
687 687 destroyRecursive(preserveDom?: boolean): void;
688 688
689 689 /**
690 690 * Destroys the DOM nodes associated with this widget.
691 691 */
692 692 destroyRendering(preserveDom?: boolean): void;
693 693
694 694 /**
695 695 * Recursively destroy the children of this widget and their
696 696 * descendants.
697 697 */
698 698 destroyDescendants(preserveDom?: boolean): void;
699 699
700 700 /**
701 701 * Deprecated. Override destroy() instead to implement custom widget tear-down
702 702 * behavior.
703 703 */
704 704 uninitialize(): boolean;
705 705
706 706 /**
707 707 * Used by widgets to signal that a synthetic event occurred, ex:
708 708 * | myWidget.emit("attrmodified-selectedChildWidget", {}).
709 709 */
710 710 emit(type: string, eventObj?: any, callbackArgs?: any[]): any;
711 711
712 712 /**
713 713 * Call specified function when event occurs, ex: myWidget.on("click", function(){ ... }).
714 714 */
715 715 on(type: string | dojo.ExtensionEvent, func: dojo.EventListener | Function): dojo.WatchHandle;
716 716
717 717 /**
718 718 * Returns a string that represents the widget.
719 719 */
720 720 toString(): string;
721 721
722 722 /**
723 723 * Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
724 724 * is this widget. Note that it does not return all descendants, but rather just direct children.
725 725 */
726 726 getChildren<T extends _WidgetBase>(): T[];
727 727
728 728 /**
729 729 * Returns the parent widget of this widget.
730 730 */
731 731 getParent<T extends _WidgetBase>(): T;
732 732
733 733 /**
734 734 * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead.
735 735 */
736 736 connect(obj: any, event: string | dojo.ExtensionEvent, method: string | dojo.EventListener): dojo.WatchHandle;
737 737
738 738 /**
739 739 * Deprecated, will be removed in 2.0, use handle.remove() instead.
740 740 */
741 741 disconnect(handle: dojo.WatchHandle): void;
742 742
743 743 /**
744 744 * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead.
745 745 */
746 746 subscribe(t: string, method: dojo.EventListener): dojo.WatchHandle;
747 747
748 748 /**
749 749 * Deprecated, will be removed in 2.0, use handle.remove() instead.
750 750 */
751 751 unsubscribe(handle: dojo.WatchHandle): void;
752 752
753 753 /**
754 754 * Return this widget's explicit or implicit orientation (true for LTR, false for RTL)
755 755 */
756 756 isLeftToRight(): boolean;
757 757
758 758 /**
759 759 * Return true if this widget can currently be focused
760 760 * and false if not
761 761 */
762 762 isFocusable(): boolean;
763 763
764 764 /**
765 765 * Place this widget somewhere in the DOM based
766 766 * on standard domConstruct.place() conventions.
767 767 */
768 768 placeAt<T extends _WidgetBase>(reference: dojo.NodeFragmentOrString | T, position?: string | number): this;
769 769
770 770 /**
771 771 * Wrapper to setTimeout to avoid deferred functions executing
772 772 * after the originating widget has been destroyed.
773 773 * Returns an object handle with a remove method (that returns null) (replaces clearTimeout).
774 774 */
775 775 defer(fcn: Function, delay?: number): dojo.Handle;
776 776 }
777 777
778 778 interface _WidgetBaseConstructor<W> extends Pick<dojo._base.DeclareConstructor<W>, Exclude<keyof dojo._base.DeclareConstructor<W>, 'new'>> {
779 779 new (params?: Partial<W> & ThisType<W>, srcNodeRef?: dojo.NodeOrString): W & dojo._base.DeclareCreatedObject;
780 780 }
781 781
782 782 /* dijit/_WidgetsInTemplateMixin */
783 783
784 784 interface _WidgetsInTemplateMixin {
785 785 /**
786 786 * Used to provide a context require to dojo/parser in order to be
787 787 * able to use relative MIDs (e.g. `./Widget`) in the widget's template.
788 788 */
789 789 contextRequire: Function;
790 790
791 791 startup(): void;
792 792 }
793 793
794 794 interface _WidgetsInTemplateMixinConstructor extends dojo._base.DeclareConstructor<_WidgetsInTemplateMixin> {
795 795 new (params: Object, srcNodeRef: dojo.NodeOrString): _WidgetsInTemplateMixin;
796 796 }
797 797
798 798 /* dijit/a11yclick */
799 799
800 800 interface A11yClick {
801 801
802 802 /**
803 803 * Custom press, release, and click synthetic events
804 804 * which trigger on a left mouse click, touch, or space/enter keyup.
805 805 */
806 806 (node: HTMLElement, listener: Function): dojo.Handle;
807 807
808 808 /**
809 809 * Mousedown (left button), touchstart, or keydown (space or enter) corresponding to logical click operation.
810 810 */
811 811 press: dojo.ExtensionEvent;
812 812
813 813 /**
814 814 * Mouseup (left button), touchend, or keyup (space or enter) corresponding to logical click operation.
815 815 */
816 816 release: dojo.ExtensionEvent;
817 817
818 818 /**
819 819 * Mouse cursor or a finger is dragged over the given node.
820 820 */
821 821 move: dojo.ExtensionEvent;
822 822 }
823 823
824 824 /* dijit/Calendar */
825 825
826 826 interface _MonthDropDownButton extends form.DropDownButton<_MonthDropDown> {
827 827 onMonthSelect(): void;
828 828 postCreate(): void;
829 829
830 830 set(name: 'month', value: number): this;
831 831 set(name: string, value: any): this;
832 832 set(values: Object): this;
833 833 }
834 834
835 835 interface _MonthDropDownButtonConstructor extends _WidgetBaseConstructor<_MonthDropDownButton> { }
836 836
837 837 interface _MonthDropDown extends _Widget, _TemplatedMixin, _CssStateMixin {
838 838 months: string[];
839 839 baseClass: string;
840 840 templateString: string;
841 841
842 842 /**
843 843 * Callback when month is selected from drop down
844 844 */
845 845 onChange(month: number): void;
846 846
847 847 set(name: 'months', value: string[]): this;
848 848 set(name: string, value: any): this;
849 849 set(values: Object): this;
850 850 }
851 851
852 852 interface _MonthDropDownConstructor extends _WidgetBaseConstructor<_MonthDropDown> { }
853 853
854 854 interface Calendar extends CalendarLite, _Widget, _CssStateMixin {
855 855
856 856 baseClass: string;
857 857
858 858 /**
859 859 * Set node classes for various mouse events, see dijit._CssStateMixin for more details
860 860 */
861 861 cssStateNodes: CSSStateNodes;
862 862
863 863 /**
864 864 * Creates the drop down button that displays the current month and lets user pick a new one
865 865 */
866 866 _createMonthWidget(): _MonthDropDownButton;
867 867
868 868 postCreate(): void;
869 869
870 870 /**
871 871 * Handler for when user selects a month from the drop down list
872 872 */
873 873 _onMonthSelect(newMonth: number): void;
874 874
875 875 /**
876 876 * Handler for mouse over events on days, sets hovered style
877 877 */
878 878 _onDayMouseOver(evt: MouseEvent): void;
879 879
880 880 /**
881 881 * Handler for mouse out events on days, clears hovered style
882 882 */
883 883 _onDayMouseOut(evt: MouseEvent): void;
884 884 _onDayMouseDown(evt: MouseEvent): void;
885 885 _onDayMouseUp(evt: MouseEvent): void;
886 886
887 887 /**
888 888 * Provides keyboard navigation of calendar.
889 889 */
890 890 handleKey(evt: KeyboardEvent): void;
891 891
892 892 /**
893 893 * For handling keydown events on a stand alone calendar
894 894 */
895 895 _onKeyDown(evt: KeyboardEvent): void;
896 896
897 897 /**
898 898 * Deprecated. Notification that a date cell was selected. It may be the same as the previous value.
899 899 */
900 900 onValueSelected(date: Date): void;
901 901
902 902 onChange(date: Date): void;
903 903
904 904 /**
905 905 * May be overridden to return CSS classes to associate with the date entry for the given dateObject
906 906 * for example to indicate a holiday in specified locale.
907 907 */
908 908 getClassForDate(dateObject: Date, locale?: string): string;
909 909
910 910 get(name: 'value'): Date;
911 911 get(name: string): any;
912 912
913 913 set(name: 'value', value: number | Date): this;
914 914 set(name: string, value: any): this;
915 915 set(values: Object): this;
916 916 }
917 917
918 918 interface CalendarConstructor extends _WidgetBaseConstructor<Calendar> {
919 919 _MonthWidget: _MonthWidgetConstructor;
920 920 _MonthDropDown: _MonthDropDownButtonConstructor;
921 921 _MonthDropDownButton: _MonthDropDownButtonConstructor;
922 922 }
923 923
924 924 /* dijit/CalendarLite */
925 925
926 926 interface _MonthWidget extends _WidgetBase {
927 927 set(name: 'month', value: Date): this;
928 928 set(name: string, value: any): this;
929 929 set(values: Object): this;
930 930 }
931 931
932 932 interface _MonthWidgetConstructor extends _WidgetBaseConstructor<_MonthWidget> { }
933 933
934 934 interface CalendarLite extends _WidgetBase, _TemplatedMixin {
935 935 /**
936 936 * Template for main calendar
937 937 */
938 938 templateString: string;
939 939
940 940 /**
941 941 * Template for cell for a day of the week (ex: M)
942 942 */
943 943 dowTemplateString: string;
944 944
945 945 dateTemplateString: string;
946 946 weekTemplateString: string;
947 947
948 948 /**
949 949 * The currently selected Date, initially set to invalid date to indicate no selection.
950 950 */
951 951 value: Date;
952 952
953 953 /**
954 954 * JavaScript namespace to find calendar routines. If unspecified, uses Gregorian calendar routines
955 955 * at dojo/date and dojo/date/locale.
956 956 */
957 957 datePackage: string;
958 958
959 959 /**
960 960 * How to represent the days of the week in the calendar header. See locale
961 961 */
962 962 dayWidth: string;
963 963
964 964 /**
965 965 * Order fields are traversed when user hits the tab key
966 966 */
967 967 tabIndex: string;
968 968
969 969 /**
970 970 * (Optional) The first day of week override. By default the first day of week is determined
971 971 * for the current locale (extracted from the CLDR).
972 972 * Special value -1 (default value), means use locale dependent value.
973 973 */
974 974 dayOffset: number;
975 975
976 976 /**
977 977 * Date object containing the currently focused date, or the date which would be focused
978 978 * if the calendar itself was focused. Also indicates which year and month to display,
979 979 * i.e. the current "page" the calendar is on.
980 980 */
981 981 currentFocus: Date;
982 982
983 983 /**
984 984 * Put the summary to the node with role=grid
985 985 */
986 986 _setSummaryAttr: string;
987 987
988 988 baseClass: string;
989 989
990 990 /**
991 991 * Runs various tests on the value, checking that it's a valid date, rather
992 992 * than blank or NaN.
993 993 */
994 994 _isValidDate(value: Date): boolean;
995 995
996 996 /**
997 997 * Convert Number into Date, or copy Date object. Then, round to nearest day,
998 998 * setting to 1am to avoid issues when DST shift occurs at midnight, see #8521, #9366)
999 999 */
1000 1000 _patchDate(value: number | Date): Date;
1001 1001
1002 1002 /**
1003 1003 * This just sets the content of node to the specified text.
1004 1004 * Can't do "node.innerHTML=text" because of an IE bug w/tables, see #3434.
1005 1005 */
1006 1006 _setText(node: HTMLElement, text?: string): void;
1007 1007
1008 1008 /**
1009 1009 * Fills in the calendar grid with each day (1-31).
1010 1010 * Call this on creation, when moving to a new month.
1011 1011 */
1012 1012 _populateGrid(): void;
1013 1013
1014 1014 /**
1015 1015 * Fill in localized month, and prev/current/next years
1016 1016 */
1017 1017 _populateControls(): void;
1018 1018
1019 1019 /**
1020 1020 * Sets calendar's value to today's date
1021 1021 */
1022 1022 goToToday(): void;
1023 1023
1024 1024 /**
1025 1025 * Creates the drop down button that displays the current month and lets user pick a new one
1026 1026 */
1027 1027 _createMonthWidget(): void;
1028 1028
1029 1029 buildRendering(): void;
1030 1030 postCreate(): void;
1031 1031
1032 1032 /**
1033 1033 * Set up connects for increment/decrement of months/years
1034 1034 */
1035 1035 _connectControls(): void;
1036 1036
1037 1037 /**
1038 1038 * If the calendar currently has focus, then focuses specified date,
1039 1039 * changing the currently displayed month/year if necessary.
1040 1040 * If the calendar doesn't have focus, updates currently
1041 1041 * displayed month/year, and sets the cell that will get focus
1042 1042 * when Calendar is focused.
1043 1043 */
1044 1044 _setCurrentFocusAttr(date: Date, forceFocus?: boolean): void;
1045 1045
1046 1046 /**
1047 1047 * Focus the calendar by focusing one of the calendar cells
1048 1048 */
1049 1049 focus(): void;
1050 1050
1051 1051 /**
1052 1052 * Handler for day clicks, selects the date if appropriate
1053 1053 */
1054 1054 _onDayClick(evt: MouseEvent): void;
1055 1055
1056 1056 /**
1057 1057 * Returns the cell corresponding to the date, or null if the date is not within the currently
1058 1058 * displayed month.
1059 1059 */
1060 1060 _getNodeByDate(value: Date): HTMLElement;
1061 1061
1062 1062 /**
1063 1063 * Marks the specified cells as selected, and clears cells previously marked as selected.
1064 1064 * For CalendarLite at most one cell is selected at any point, but this allows an array
1065 1065 * for easy subclassing.
1066 1066 */
1067 1067 _markSelectedDates(dates: Date[]): void;
1068 1068
1069 1069 /**
1070 1070 * Called only when the selected date has changed
1071 1071 */
1072 1072 onChange(date: Date): void;
1073 1073
1074 1074 /**
1075 1075 * May be overridden to disable certain dates in the calendar e.g. `isDisabledDate=dojo.date.locale.isWeekend`
1076 1076 */
1077 1077 isDisabledDate(dateObject: Date, locale?: string): boolean;
1078 1078
1079 1079 /**
1080 1080 * May be overridden to return CSS classes to associate with the date entry for the given dateObject,
1081 1081 * for example to indicate a holiday in specified locale.
1082 1082 */
1083 1083 getClassForDate(dateObject: Date, locale?: string): string;
1084 1084
1085 1085 get(name: 'value'): Date;
1086 1086 get(name: string): any;
1087 1087
1088 1088 set(name: 'value', value: number | Date): this;
1089 1089 set(name: string, value: any): this;
1090 1090 set(values: Object): this;
1091 1091 }
1092 1092
1093 1093 interface CalendarLiteConstructor extends _WidgetBaseConstructor<CalendarLite> {
1094 1094 _MonthWidget: _MonthWidgetConstructor;
1095 1095 }
1096 1096
1097 1097 /* dijit/Destroyable */
1098 1098
1099 1099 interface Destroyable {
1100 1100 _destroyed?: true;
1101 1101
1102 1102 /**
1103 1103 * Destroy this class, releasing any resources registered via own().
1104 1104 */
1105 1105 destroy(preserveDom?: boolean): void;
1106 1106
1107 1107 /**
1108 1108 * Track specified handles and remove/destroy them when this instance is destroyed, unless they were
1109 1109 * already removed/destroyed manually.
1110 1110 */
1111 1111 own(...args: any[]): any[];
1112 1112 }
1113 1113
1114 1114 /**
1115 1115 * Mixin to track handles and release them when instance is destroyed.
1116 1116 */
1117 1117 interface DestroyableConstructor extends dojo._base.DeclareConstructor<Destroyable> { }
1118 1118
1119 1119 /** dijit/_KeyNavMixin */
1120 1120
1121 1121 /**
1122 1122 * A mixin to allow arrow key and letter key navigation of child or descendant widgets.
1123 1123 * It can be used by dijit/_Container based widgets with a flat list of children, or more complex widgets like dijit/Tree.
1124 1124 *
1125 1125 * To use this mixin, the subclass must:
1126 1126 *
1127 1127 * - Implement _getNext(), _getFirst(), _getLast(), _onLeftArrow(), _onRightArrow() _onDownArrow(), _onUpArrow() methods to handle home/end/left/right/up/down keystrokes. Next and previous in this context refer to a linear ordering of the descendants used by letter key search.
1128 1128 * - Set all descendants' initial tabIndex to "-1"; both initial descendants and any descendants added later, by for example addChild()
1129 1129 * - Define childSelector to a function or string that identifies focusable descendant widgets
1130 1130 *
1131 1131 * Also, child widgets must implement a focus() method.
1132 1132 */
1133 1133 interface _KeyNavMixin extends _FocusMixin {
1134 1134 /**
1135 1135 * Tab index of the container; same as HTML tabIndex attribute.
1136 1136 * Note then when user tabs into the container, focus is immediately moved to the first item in the container.
1137 1137 */
1138 1138 tabIndex: string;
1139 1139
1140 1140 /**
1141 1141 * Selector (passed to on.selector()) used to identify what to treat as a child widget. Used to monitor focus events and set this.focusedChild. Must be set by implementing class. If this is a string (ex: "> *") then the implementing class must require dojo/query.
1142 1142 */
1143 1143 childSelector: string | Function | null;
1144 1144
1145 1145 /**
1146 1146 * Called on left arrow key, or right arrow key if widget is in RTL mode.
1147 1147 * Should go back to the previous child in horizontal container widgets like Toolbar.
1148 1148 */
1149 1149 _onLeftArrow(evt?: KeyboardEvent): void;
1150 1150
1151 1151 /**
1152 1152 * Called on right arrow key, or left arrow key if widget is in RTL mode.
1153 1153 * Should go to the next child in horizontal container widgets like Toolbar.
1154 1154 */
1155 1155 _onRightArrow(evt?: KeyboardEvent): void;
1156 1156
1157 1157 /**
1158 1158 * Called on up arrow key. Should go to the previous child in vertical container widgets like Menu.
1159 1159 */
1160 1160 _onUpArrow(evt?: KeyboardEvent): void;
1161 1161
1162 1162 /**
1163 1163 * Called on down arrow key. Should go to the next child in vertical container widgets like Menu.
1164 1164 */
1165 1165 _onDownArrow(evt?: KeyboardEvent): void;
1166 1166
1167 1167 /**
1168 1168 * Default focus() implementation: focus the first child.
1169 1169 */
1170 1170 focus(): void;
1171 1171
1172 1172 /**
1173 1173 * Returns first child that can be focused.
1174 1174 */
1175 1175 _getFirstFocusableChild(): _WidgetBase;
1176 1176
1177 1177 /**
1178 1178 * Returns last child that can be focused.
1179 1179 */
1180 1180 _getLastFocusableChild(): _WidgetBase;
1181 1181
1182 1182 /**
1183 1183 * Focus the first focusable child in the container.
1184 1184 */
1185 1185 focusFirstChild(): void;
1186 1186
1187 1187 /**
1188 1188 * Focus the last focusable child in the container.
1189 1189 */
1190 1190 focusLastChild(): void;
1191 1191
1192 1192 /**
1193 1193 * Focus specified child widget.
1194 1194 *
1195 1195 * @param widget Reference to container's child widget
1196 1196 * @param last If true and if widget has multiple focusable nodes, focus the last one instead of the first one
1197 1197 */
1198 1198 focusChild(widget: _WidgetBase, last?: boolean): void;
1199 1199
1200 1200 /**
1201 1201 * Handler for when the container itself gets focus.
1202 1202 *
1203 1203 * Initially the container itself has a tabIndex, but when it gets focus, switch focus to first child.
1204 1204 */
1205 1205 _onContainerFocus(evt: Event): void;
1206 1206
1207 1207 /**
1208 1208 * Called when a child widget gets focus, either by user clicking it, or programatically by arrow key handling code.
1209 1209 *
1210 1210 * It marks that the current node is the selected one, and the previously selected node no longer is.
1211 1211 */
1212 1212 _onChildFocus(child?: _WidgetBase): void;
1213 1213
1214 1214 _searchString: string;
1215 1215
1216 1216 multiCharSearchDuration: number;
1217 1217
1218 1218 /**
1219 1219 * When a key is pressed that matches a child item, this method is called so that a widget can take appropriate action is necessary.
1220 1220 */
1221 1221 onKeyboardSearch(tem: _WidgetBase, evt: Event, searchString: string, numMatches: number): void;
1222 1222
1223 1223 /**
1224 1224 * Compares the searchString to the widget's text label, returning:
1225 1225 *
1226 1226 * * -1: a high priority match and stop searching
1227 1227 * * 0: not a match
1228 1228 * * 1: a match but keep looking for a higher priority match
1229 1229 */
1230 1230 _keyboardSearchCompare(item: _WidgetBase, searchString: string): -1 | 0 | 1;
1231 1231
1232 1232 /**
1233 1233 * When a key is pressed, if it's an arrow key etc. then it's handled here.
1234 1234 */
1235 1235 _onContainerKeydown(evt: Event): void;
1236 1236
1237 1237 /**
1238 1238 * When a printable key is pressed, it's handled here, searching by letter.
1239 1239 */
1240 1240 _onContainerKeypress(evt: Event): void;
1241 1241
1242 1242 /**
1243 1243 * Perform a search of the widget's options based on the user's keyboard activity
1244 1244 *
1245 1245 * Called on keypress (and sometimes keydown), searches through this widget's children looking for items that match the user's typed search string. Multiple characters typed within 1 sec of each other are combined for multicharacter searching.
1246 1246 */
1247 1247 _keyboardSearch(evt: Event, keyChar: string): void;
1248 1248
1249 1249 /**
1250 1250 * Called when focus leaves a child widget to go to a sibling widget.
1251 1251 */
1252 1252 _onChildBlur(widget: _WidgetBase): void;
1253 1253
1254 1254 /**
1255 1255 * Returns the next or previous focusable descendant, compared to "child".
1256 1256 * Implements and extends _KeyNavMixin._getNextFocusableChild() for a _Container.
1257 1257 */
1258 1258 _getNextFocusableChild(child: _WidgetBase, dir: 1 | -1): _WidgetBase | null;
1259 1259
1260 1260 /**
1261 1261 * Returns the first child.
1262 1262 */
1263 1263 _getFirst(): _WidgetBase | null;
1264 1264
1265 1265 /**
1266 1266 * Returns the last descendant.
1267 1267 */
1268 1268 _getLast(): _WidgetBase | null;
1269 1269
1270 1270 /**
1271 1271 * Returns the next descendant, compared to "child".
1272 1272 */
1273 1273 _getNext(child: _WidgetBase, dir: 1 | -1): _WidgetBase | null;
1274 1274 }
1275 1275
1276 1276 interface _KeyNavMixinConstructor extends dojo._base.DeclareConstructor<_KeyNavMixin> { }
1277 1277
1278 1278 /* dijit/_KeyNavContainer */
1279 1279
1280 1280 /**
1281 1281 * A _Container with keyboard navigation of its children.
1282 1282 *
1283 1283 * Provides normalized keyboard and focusing code for Container widgets.
1284 1284 * To use this mixin, call connectKeyNavHandlers() in postCreate().
1285 1285 * Also, child widgets must implement a focus() method.
1286 1286 */
1287 1287 interface _KeyNavContainer extends _FocusMixin, _KeyNavMixin, _Container {
1288 1288 /**
1289 1289 * Deprecated. You can call this in postCreate() to attach the keyboard handlers to the container, but the preferred method is to override _onLeftArrow() and _onRightArrow(), or _onUpArrow() and _onDownArrow(), to call focusPrev() and focusNext().
1290 1290 *
1291 1291 * @param prevKeyCodes Key codes for navigating to the previous child.
1292 1292 * @param nextKeyCodes Key codes for navigating to the next child.
1293 1293 */
1294 1294 connectKeyNavHandlers(prevKeyCodes: number[], nextKeyCodes: number[]): void;
1295 1295
1296 1296 /**
1297 1297 * @deprecated
1298 1298 */
1299 1299 startupKeyNavChildren(): void;
1300 1300
1301 1301 /**
1302 1302 * Setup for each child widget.
1303 1303 *
1304 1304 * Sets tabIndex=-1 on each child, so that the tab key will leave the container rather than visiting each child.
1305 1305 *
1306 1306 * Note: if you add children by a different method than addChild(), then need to call this manually or at least make sure the child's tabIndex is -1.
1307 1307 *
1308 1308 * Note: see also _LayoutWidget.setupChild(), which is also called for each child widget.
1309 1309 */
1310 1310 _startupChild(widget: _WidgetBase): void;
1311 1311
1312 1312 /**
1313 1313 * Returns the first child.
1314 1314 */
1315 1315 _getFirst(): _Widget | null;
1316 1316
1317 1317 /**
1318 1318 * Returns the last descendant.
1319 1319 */
1320 1320 _getLast(): _Widget | null;
1321 1321
1322 1322 /**
1323 1323 * Focus the next widget
1324 1324 */
1325 1325 focusNext(): void;
1326 1326
1327 1327 /**
1328 1328 * Focus the last focusable node in the previous widget
1329 1329 *
1330 1330 * (ex: go to the ComboButton icon section rather than button section)
1331 1331 */
1332 1332 focusPrev(): void;
1333 1333
1334 1334 /**
1335 1335 * Implement _KeyNavMixin.childSelector, to identify focusable child nodes.
1336 1336 *
1337 1337 * If we allowed a dojo/query dependency from this module this could more simply be a string "> *" instead of this function.
1338 1338 */
1339 1339 childSelector(node: Element | Node): boolean | void | any;
1340 1340 }
1341 1341
1342 1342 interface _KeyNavContainerConstructor extends dojo._base.DeclareConstructor<_KeyNavContainer> { }
1343 1343
1344 1344 /* dijit/_MenuBase */
1345 1345
1346 1346 /**
1347 1347 * Abstract base class for Menu and MenuBar.
1348 1348 * Subclass should implement _onUpArrow(), _onDownArrow(), _onLeftArrow(), and _onRightArrow().
1349 1349 */
1350 1350 interface _MenuBase extends _Widget, _TemplatedMixin, _KeyNavContainer, _CssStateMixin {
1351 1351 selected: MenuItem | null;
1352 1352
1353 1353 _setSelectedAttr(item?: MenuItem | null): void;
1354 1354
1355 1355 /**
1356 1356 * This Menu has been clicked (mouse or via space/arrow key) or opened as a submenu, so mere mouseover will open submenus. Focusing a menu via TAB does NOT automatically make it active since TAB is a navigation operation and not a selection one.
1357 1357 *
1358 1358 * For Windows apps, pressing the ALT key focuses the menubar menus (similar to TAB navigation) but the menu is not active (ie no dropdown) until an item is clicked.
1359 1359 */
1360 1360 activated: boolean;
1361 1361
1362 1362 _setActivatedAttr(val: boolean): void;
1363 1363
1364 1364 /**
1365 1365 * pointer to menu that displayed me
1366 1366 */
1367 1367 parentMenu: _Widget | null;
1368 1368
1369 1369 /**
1370 1370 * After a menu has been activated (by clicking on it etc.), number of milliseconds before hovering (without clicking) another MenuItem causes that MenuItem's popup to automatically open.
1371 1371 */
1372 1372 popupDelay: number;
1373 1373
1374 1374 /**
1375 1375 * For a passive (unclicked) Menu, number of milliseconds before hovering (without clicking) will cause the popup to open. Default is Infinity, meaning you need to click the menu to open it.
1376 1376 */
1377 1377 passivePopupDelay: number;
1378 1378
1379 1379 /**
1380 1380 * A toggle to control whether or not a Menu gets focused when opened as a drop down from a MenuBar or DropDownButton/ComboButton. Note though that it always get focused when opened via the keyboard.
1381 1381 */
1382 1382 autoFocus: boolean;
1383 1383
1384 1384 /**
1385 1385 * Selector (passed to on.selector()) used to identify MenuItem child widgets, but exclude inert children like MenuSeparator. If subclass overrides to a string (ex: "> *"), the subclass must require dojo/query.
1386 1386 */
1387 1387 childSelector(node: Element | Node): boolean | void | Function;
1388 1388
1389 1389 /**
1390 1390 * Attach point for notification about when a menu item has been executed. This is an internal mechanism used for Menus to signal to their parent to close them, because they are about to execute the onClick handler. In general developers should not attach to or override this method.
1391 1391 */
1392 1392 onExecute(): void;
1393 1393
1394 1394 /**
1395 1395 * Attach point for notification about when the user cancels the current menu
1396 1396 * This is an internal mechanism used for Menus to signal to their parent to close them. In general developers should not attach to or override this method.
1397 1397 */
1398 1398 onCancel(): void;
1399 1399
1400 1400 /**
1401 1401 * This handles the right arrow key (left arrow key on RTL systems), which will either open a submenu, or move to the next item in the ancestor MenuBar
1402 1402 */
1403 1403 _moveToPopup(evt: Event): void;
1404 1404
1405 1405 /**
1406 1406 * This handler is called when the mouse moves over the popup.
1407 1407 */
1408 1408 _onPopupHover(evt?: MouseEvent): void;
1409 1409
1410 1410 /**
1411 1411 * Called when cursor is over a MenuItem.
1412 1412 */
1413 1413 onItemHover(item: MenuItem): void;
1414 1414
1415 1415 /**
1416 1416 * Called when a child MenuItem becomes deselected. Setup timer to close its popup.
1417 1417 */
1418 1418 _onChildDeselect(item: MenuItem): void;
1419 1419
1420 1420 /**
1421 1421 * Callback fires when mouse exits a MenuItem
1422 1422 */
1423 1423 onItemUnhover(item: MenuItem): void;
1424 1424
1425 1425 /**
1426 1426 * Cancels the popup timer because the user has stop hovering on the MenuItem, etc.
1427 1427 */
1428 1428 _stopPopupTimer(): void;
1429 1429
1430 1430 /**
1431 1431 * Cancels the pending-close timer because the close has been preempted
1432 1432 */
1433 1433 _stopPendingCloseTimer(): void;
1434 1434
1435 1435 /**
1436 1436 * Returns the top menu in this chain of Menus
1437 1437 */
1438 1438 _getTopMenu(): void;
1439 1439
1440 1440 /**
1441 1441 * Handle clicks on an item.
1442 1442 */
1443 1443 onItemClick(item: _WidgetBase, evt: Event): void;
1444 1444
1445 1445 /**
1446 1446 * Open the popup to the side of/underneath the current menu item, and optionally focus first item
1447 1447 */
1448 1448 _openItemPopup(fromItem: MenuItem, focus: boolean): void;
1449 1449
1450 1450 /**
1451 1451 * Callback when this menu is opened.
1452 1452 * This is called by the popup manager as notification that the menu was opened.
1453 1453 */
1454 1454 onOpen(evt?: Event): void;
1455 1455
1456 1456 /**
1457 1457 * Callback when this menu is closed.
1458 1458 * This is called by the popup manager as notification that the menu was closed.
1459 1459 */
1460 1460 onClose(): boolean;
1461 1461
1462 1462 /**
1463 1463 * Called when submenu is clicked or focus is lost. Close hierarchy of menus.
1464 1464 */
1465 1465 _closeChild(): void;
1466 1466 /**
1467 1467 * Called when child of this Menu gets focus from:
1468 1468 *
1469 1469 * 1. clicking it
1470 1470 * 2. tabbing into it
1471 1471 * 3. being opened by a parent menu.
1472 1472 *
1473 1473 * This is not called just from mouse hover.
1474 1474 */
1475 1475 _onItemFocus(item: MenuItem): void;
1476 1476
1477 1477 /**
1478 1478 * Called when focus is moved away from this Menu and it's submenus.
1479 1479 */
1480 1480 _onBlur(): void;
1481 1481
1482 1482 /**
1483 1483 * Called when the user is done with this menu. Closes hierarchy of menus.
1484 1484 */
1485 1485 _cleanUp(clearSelectedItem?: boolean): void;
1486 1486 }
1487 1487
1488 1488 interface _MenuBaseConstructor extends _WidgetBaseConstructor<_MenuBase> { }
1489 1489
1490 1490 /* dijit/Dialog */
1491 1491
1492 1492 interface _DialogBase extends _TemplatedMixin, form._FormMixin, _DialogMixin, _CssStateMixin {
1493 1493 templateString: string;
1494 1494 baseClass: string;
1495 1495 cssStateNodes: CSSStateNodes;
1496 1496
1497 1497 /**
1498 1498 * True if Dialog is currently displayed on screen.
1499 1499 */
1500 1500 open: boolean;
1501 1501
1502 1502 /**
1503 1503 * The time in milliseconds it takes the dialog to fade in and out
1504 1504 */
1505 1505 duration: number;
1506 1506
1507 1507 /**
1508 1508 * A Toggle to modify the default focus behavior of a Dialog, which
1509 1509 * is to re-focus the element which had focus before being opened.
1510 1510 * False will disable refocusing. Default: true
1511 1511 */
1512 1512 refocus: boolean;
1513 1513
1514 1514 /**
1515 1515 * A Toggle to modify the default focus behavior of a Dialog, which
1516 1516 * is to focus on the first dialog element after opening the dialog.
1517 1517 * False will disable autofocusing. Default: true
1518 1518 */
1519 1519 autofocus: boolean;
1520 1520
1521 1521 /**
1522 1522 * Toggles the movable aspect of the Dialog. If true, Dialog
1523 1523 * can be dragged by it's title. If false it will remain centered
1524 1524 * in the viewport.
1525 1525 */
1526 1526 draggable: boolean;
1527 1527
1528 1528 /**
1529 1529 * Maximum size to allow the dialog to expand to, relative to viewport size
1530 1530 */
1531 1531 maxRatio: number;
1532 1532
1533 1533 /**
1534 1534 * Dialog show [x] icon to close itself, and ESC key will close the dialog.
1535 1535 */
1536 1536 closable: boolean;
1537 1537 postMixInProperties(): void;
1538 1538 postCreate(): void;
1539 1539
1540 1540 /**
1541 1541 * Called when data has been loaded from an href.
1542 1542 * Unlike most other callbacks, this function can be connected to (via `dojo.connect`)
1543 1543 * but should *not* be overridden.
1544 1544 */
1545 1545 onLoad(data?: any): void;
1546 1546
1547 1547 focus(): void;
1548 1548
1549 1549 /* Not entirely sure of the resolution type of these promises */
1550 1550
1551 1551 /**
1552 1552 * Display the dialog
1553 1553 */
1554 1554 show(): dojo.promise.Promise<any>;
1555 1555
1556 1556 /**
1557 1557 * Hide the dialog
1558 1558 */
1559 1559 hide(): dojo.promise.Promise<any>;
1560 1560
1561 1561 /**
1562 1562 * Called with no argument when viewport scrolled or viewport size changed. Adjusts Dialog as
1563 1563 * necessary to keep it visible.
1564 1564 *
1565 1565 * Can also be called with an argument (by dojox/layout/ResizeHandle etc.) to explicitly set the
1566 1566 * size of the dialog.
1567 1567 */
1568 1568 resize(dim?: dojo.DomGeometryWidthHeight): void;
1569 1569
1570 1570 destroy(preserveDom?: boolean): void;
1571 1571 }
1572 1572
1573 1573 interface _DialogBaseConstructor extends _WidgetBaseConstructor<_DialogBase> { }
1574 1574
1575 1575 interface Dialog extends layout.ContentPane, _DialogBase {
1576 1576 /* overrides conflicting methods */
1577 1577 resize(dim?: dojo.DomGeometryWidthHeight): void;
1578 1578 }
1579 1579
1580 1580 interface DialogLevelManager {
1581 1581 _beginZIndex: number;
1582 1582
1583 1583 /**
1584 1584 * Call right before fade-in animation for new dialog.
1585 1585 *
1586 1586 * Saves current focus, displays/adjusts underlay for new dialog,
1587 1587 * and sets the z-index of the dialog itself.
1588 1588 *
1589 1589 * New dialog will be displayed on top of all currently displayed dialogs.
1590 1590 * Caller is responsible for setting focus in new dialog after the fade-in
1591 1591 * animation completes.
1592 1592 */
1593 1593 show(dialog: _WidgetBase, underlayAttrs: Object): void;
1594 1594
1595 1595 /**
1596 1596 * Called when the specified dialog is hidden/destroyed, after the fade-out
1597 1597 * animation ends, in order to reset page focus, fix the underlay, etc.
1598 1598 * If the specified dialog isn't open then does nothing.
1599 1599 *
1600 1600 * Caller is responsible for either setting display:none on the dialog domNode,
1601 1601 * or calling dijit/popup.hide(), or removing it from the page DOM.
1602 1602 */
1603 1603 hide(dialog: _WidgetBase): void;
1604 1604
1605 1605 /**
1606 1606 * Returns true if specified Dialog is the top in the task
1607 1607 */
1608 1608 isTop(dialog: _WidgetBase): boolean;
1609 1609 }
1610 1610
1611 1611 interface DialogConstructor extends _WidgetBaseConstructor<Dialog> {
1612 1612 /**
1613 1613 * for monkey patching and dojox/widget/DialogSimple
1614 1614 */
1615 1615 _DialogBase: _DialogBaseConstructor;
1616 1616 _DialogLevelManager: DialogLevelManager;
1617 1617 _dialogStack: {
1618 1618 dialog: _WidgetBase,
1619 1619 focus: any,
1620 1620 underlayAttrs: any
1621 1621 }[];
1622 1622 }
1623 1623
1624 1624 /* dijit/ConfirmDialog */
1625 1625
1626 1626 interface ConfirmDialog extends _ConfirmDialogMixin { }
1627 1627
1628 1628 interface ConfirmDialogConstructor extends DialogConstructor { }
1629 1629
1630 1630 /* dijit/DropDownMenu */
1631 1631
1632 1632 /**
1633 1633 * A menu, without features for context menu (Meaning, drop down menu)
1634 1634 */
1635 1635 interface DropDownMenu extends _MenuBase { }
1636 1636
1637 1637 interface DropDownMenuConstructor extends _WidgetBaseConstructor<DropDownMenu> { }
1638 1638
1639 1639 /* dijit/Fieldset */
1640 1640
1641 1641 /**
1642 1642 * An accessible fieldset that can be expanded or collapsed via
1643 1643 * its legend. Fieldset extends `dijit.TitlePane`.
1644 1644 */
1645 1645 interface Fieldset extends TitlePane {
1646 1646 open: boolean;
1647 1647 }
1648 1648
1649 1649 interface FieldsetConstructor extends _WidgetBaseConstructor<Fieldset> { }
1650 1650
1651 1651 /* dijit/Menu */
1652 1652
1653 1653 /**
1654 1654 * A context menu you can assign to multiple elements
1655 1655 */
1656 1656 interface Menu extends dijit.DropDownMenu {
1657 1657 /**
1658 1658 * Array of dom node ids of nodes to attach to.
1659 1659 * Fill this with nodeIds upon widget creation and it becomes context menu for those nodes.
1660 1660 */
1661 1661 targetNodeIds: string[];
1662 1662
1663 1663 /**
1664 1664 * CSS expression to apply this Menu to descendants of targetNodeIds, rather than to
1665 1665 * the nodes specified by targetNodeIds themselves. Useful for applying a Menu to
1666 1666 * a range of rows in a table, tree, etc.
1667 1667 *
1668 1668 * The application must require() an appropriate level of dojo/query to handle the selector.
1669 1669 */
1670 1670 selector: string;
1671 1671
1672 1672 /**
1673 1673 * If true, right clicking anywhere on the window will cause this context menu to open.
1674 1674 * If false, must specify targetNodeIds.
1675 1675 */
1676 1676 contextMenuForWindow: boolean;
1677 1677
1678 1678 /**
1679 1679 * If true, menu will open on left click instead of right click, similar to a file menu.
1680 1680 */
1681 1681 leftClickToOpen: boolean;
1682 1682
1683 1683 /**
1684 1684 * When this menu closes, re-focus the element which had focus before it was opened.
1685 1685 */
1686 1686 refocus: boolean;
1687 1687
1688 1688 /**
1689 1689 * Attach menu to given node
1690 1690 */
1691 1691 bindDomNode(node: string | Node): void;
1692 1692
1693 1693 /**
1694 1694 * Detach menu from given node
1695 1695 */
1696 1696 unBindDomNode(nodeName: string | Node): void;
1697 1697 }
1698 1698
1699 1699 interface MenuConstructor extends _WidgetBaseConstructor<Menu> { }
1700 1700
1701 1701 /* dijit/MenuBar */
1702 1702 interface MenuBar extends _MenuBase {
1703 1703 baseClass: 'dijitMenuBar';
1704 1704 popupDelay: number;
1705 1705 _isMenuBar: true;
1706 1706 _orient: string[];
1707 1707 _moveToPopup(evt: Event): void;
1708 1708 focusChild(item: _WidgetBase): void;
1709 1709 _onChildDeselect(item: _WidgetBase): void;
1710 1710 _onLeftArrow(): void;
1711 1711 _onRightArrow(): void;
1712 1712 _onDownArrow(): void;
1713 1713 _onUpArrow(): void;
1714 1714 onItemClick(item: _WidgetBase, evt: Event): void;
1715 1715 }
1716 1716
1717 1717 interface MenuBarConstructor extends _WidgetBaseConstructor<MenuBar> { }
1718 1718
1719 1719 /* dijit/MenuBarItem */
1720 1720 interface MenuBarItem extends MenuItem { }
1721 1721
1722 1722 interface MenuBarItemConstructor extends _WidgetBaseConstructor<MenuBarItem> { }
1723 1723
1724 1724 /* dijit/MenuItem */
1725 1725 interface MenuItem extends _Widget, _TemplatedMixin, _Contained, _CssStateMixin {
1726 1726 /**
1727 1727 * Text for the accelerator (shortcut) key combination, a control, alt, etc. modified keystroke meant to execute the menu item regardless of where the focus is on the page.
1728 1728 *
1729 1729 * Note that although Menu can display accelerator keys, there is no infrastructure to actually catch and execute those accelerators.
1730 1730 */
1731 1731 accelKey: string;
1732 1732
1733 1733 /**
1734 1734 * If true, the menu item is disabled.
1735 1735 * If false, the menu item is enabled.
1736 1736 */
1737 1737 disabled: boolean;
1738 1738
1739 1739 /** Menu text as HTML */
1740 1740 label: string;
1741 1741
1742 1742 /**
1743 1743 * Class to apply to DOMNode to make it display an icon.
1744 1744 */
1745 1745 iconClass: string;
1746 1746
1747 1747 /**
1748 1748 * Hook for attr('accelKey', ...) to work.
1749 1749 * Set accelKey on this menu item.
1750 1750 */
1751 1751 _setAccelKeyAttr(value: string): void;
1752 1752
1753 1753 /**
1754 1754 * Hook for attr('disabled', ...) to work.
1755 1755 * Enable or disable this menu item.
1756 1756 */
1757 1757 _setDisabledAttr(value: boolean): void;
1758 1758
1759 1759 _setLabelAttr(val: string): void;
1760 1760 _setIconClassAttr(val: string): void;
1761 1761
1762 1762 _fillContent(source: Element): void;
1763 1763
1764 1764 /**
1765 1765 * Indicate that this node is the currently selected one
1766 1766 */
1767 1767 _setSelected(selected: boolean): void;
1768 1768
1769 1769 focus(): void;
1770 1770
1771 1771 /**
1772 1772 * Deprecated.
1773 1773 * Use set('disabled', bool) instead.
1774 1774 */
1775 1775 setDisabled(disabled: boolean): void;
1776 1776
1777 1777 /**
1778 1778 * Deprecated.
1779 1779 * Use set('label', ...) instead.
1780 1780 */
1781 1781 setLabel(content: string): void;
1782 1782 }
1783 1783
1784 1784 interface MenuItemConstructor extends _WidgetBaseConstructor<MenuItem> { }
1785 1785
1786 1786 /* dijit/MenuSeparator */
1787 1787 interface MenuSeparator extends _WidgetBase, _TemplatedMixin, _Contained { }
1788 1788
1789 1789 interface MenuSeparatorConstructor extends _WidgetBaseConstructor<MenuSeparator> { }
1790 1790
1791 1791 /* dijit/place */
1792 1792
1793 1793 interface PlacePosition {
1794 1794 x: number;
1795 1795 y: number;
1796 1796 }
1797 1797
1798 1798 interface PlaceWidthHeight {
1799 1799 w: number;
1800 1800 h: number;
1801 1801 }
1802 1802
1803 1803 interface PlaceRectangle extends PlacePosition, PlaceWidthHeight { }
1804 1804
1805 1805 type PlaceCorner = 'BL' | 'TR' | 'BR' | 'TL';
1806 1806
1807 1807 type PlacePositions = 'before' | 'after' | 'before-centered' | 'after-centered' | 'above-centered' | 'above' | 'above-alt' | 'below-centered' | 'below' | 'below-alt';
1808 1808
1809 1809 interface PlaceChoice {
1810 1810 corner: PlaceCorner;
1811 1811 pos: PlacePosition;
1812 1812 aroundCorner?: PlaceCorner;
1813 1813 }
1814 1814
1815 1815 interface PlaceLocation extends PlaceRectangle {
1816 1816 corner: PlaceCorner;
1817 1817 aroundCorner: PlaceCorner;
1818 1818 overflow: number;
1819 1819 spaceAvailable: PlaceWidthHeight;
1820 1820 }
1821 1821
1822 1822 interface LayoutNodeFunction {
1823 1823 (node: HTMLElement, aroundCorner: string, corner: string, spaceAvailable: PlaceWidthHeight, aroundNodeCoords: PlaceWidthHeight): number;
1824 1824 }
1825 1825
1826 1826 interface Place {
1827 1827 /**
1828 1828 * Positions node kitty-corner to the rectangle centered at (pos.x, pos.y) with width and height of
1829 1829 * padding.x * 2 and padding.y * 2, or zero if padding not specified. Picks first corner in corners[]
1830 1830 * where node is fully visible, or the corner where it's most visible.
1831 1831 *
1832 1832 * Node is assumed to be absolutely or relatively positioned.
1833 1833 */
1834 1834 at(node: Element, pos?: PlacePosition, corners?: PlaceCorner[], padding?: PlacePosition, layoutNode?: LayoutNodeFunction): PlaceLocation;
1835 1835
1836 1836 /**
1837 1837 * Position node adjacent or kitty-corner to anchor
1838 1838 * such that it's fully visible in viewport.
1839 1839 */
1840 1840 around(node: Element, anchor: Element | PlaceRectangle, positions: PlacePositions[], leftToRight?: boolean, layoutNode?: LayoutNodeFunction): PlaceLocation;
1841 1841 }
1842 1842
1843 1843 /* dijit/popup */
1844 1844
1845 1845 interface PopupOpenArgs {
1846 1846 /**
1847 1847 * widget to display
1848 1848 */
1849 1849 popup?: _WidgetBase;
1850 1850
1851 1851 /**
1852 1852 * the button etc. that is displaying this popup
1853 1853 */
1854 1854 parent?: _WidgetBase;
1855 1855
1856 1856 /**
1857 1857 * DOM node (typically a button); place popup relative to this node. (Specify this *or* "x" and "y" parameters.)
1858 1858 */
1859 1859 around?: HTMLElement;
1860 1860
1861 1861 /**
1862 1862 * Absolute horizontal position (in pixels) to place node at. (Specify this *or* "around" parameter.)
1863 1863 */
1864 1864 x?: number;
1865 1865
1866 1866 /**
1867 1867 * Absolute vertical position (in pixels) to place node at. (Specify this *or* "around" parameter.)
1868 1868 */
1869 1869 y?: number;
1870 1870
1871 1871 /**
1872 1872 * When the around parameter is specified, orient should be a list of positions to try
1873 1873 */
1874 1874 orient?: string | string[] | { BL?: string; TR?: string; TL?: string; BR?: string; };
1875 1875
1876 1876 /**
1877 1877 * callback when user has canceled the popup by:
1878 1878 *
1879 1879 * 1. hitting ESC or
1880 1880 * 2. by using the popup widget's proprietary cancel mechanism (like a cancel button in a dialog);
1881 1881 * i.e. whenever popupWidget.onCancel() is called, args.onCancel is called
1882 1882 */
1883 1883 onCancel?: () => void;
1884 1884
1885 1885 /**
1886 1886 * callback whenever this popup is closed
1887 1887 */
1888 1888 onClose?: () => void;
1889 1889
1890 1890 /**
1891 1891 * callback when user "executed" on the popup/sub-popup by selecting a menu choice, etc. (top menu only)
1892 1892 */
1893 1893 onExecute?: () => void;
1894 1894
1895 1895 /**
1896 1896 * adding a buffer around the opening position. This is only useful when around is not set.
1897 1897 */
1898 1898 padding?: PlacePosition;
1899 1899
1900 1900 /**
1901 1901 * The max height for the popup. Any popup taller than this will have scrollbars.
1902 1902 * Set to Infinity for no max height. Default is to limit height to available space in viewport,
1903 1903 * above or below the aroundNode or specified x/y position.
1904 1904 */
1905 1905 maxHeight?: number;
1906 1906 }
1907 1907
1908 1908 interface PopupManager {
1909 1909 /**
1910 1910 * Stack of currently popped up widgets.
1911 1911 * (someone opened _stack[0], and then it opened _stack[1], etc.)
1912 1912 */
1913 1913 _stack: _WidgetBase[];
1914 1914
1915 1915 /**
1916 1916 * Z-index of the first popup. (If first popup opens other
1917 1917 * popups they get a higher z-index.)
1918 1918 */
1919 1919 _beginZIndex: number;
1920 1920
1921 1921 _idGen: number;
1922 1922
1923 1923 /**
1924 1924 * If screen has been scrolled, reposition all the popups in the stack.
1925 1925 * Then set timer to check again later.
1926 1926 */
1927 1927 _repositionAll(): void;
1928 1928
1929 1929 /**
1930 1930 * Initialization for widgets that will be used as popups.
1931 1931 * Puts widget inside a wrapper DIV (if not already in one),
1932 1932 * and returns pointer to that wrapper DIV.
1933 1933 */
1934 1934 _createWrapper(widget: _WidgetBase): HTMLDivElement;
1935 1935
1936 1936 /**
1937 1937 * Moves the popup widget off-screen.
1938 1938 * Do not use this method to hide popups when not in use, because
1939 1939 * that will create an accessibility issue: the offscreen popup is
1940 1940 * still in the tabbing order.
1941 1941 */
1942 1942 moveOffScreen(widget: _WidgetBase): HTMLDivElement;
1943 1943
1944 1944 /**
1945 1945 * Hide this popup widget (until it is ready to be shown).
1946 1946 * Initialization for widgets that will be used as popups
1947 1947 *
1948 1948 * Also puts widget inside a wrapper DIV (if not already in one)
1949 1949 *
1950 1950 * If popup widget needs to layout it should
1951 1951 * do so when it is made visible, and popup._onShow() is called.
1952 1952 */
1953 1953 hide(widget: _WidgetBase): void;
1954 1954
1955 1955 /**
1956 1956 * Compute the closest ancestor popup that's *not* a child of another popup.
1957 1957 * Ex: For a TooltipDialog with a button that spawns a tree of menus, find the popup of the button.
1958 1958 */
1959 1959 getTopPopup(): _WidgetBase;
1960 1960
1961 1961 /**
1962 1962 * Popup the widget at the specified position
1963 1963 */
1964 1964 open(args: PopupOpenArgs): PlaceLocation;
1965 1965
1966 1966 /**
1967 1967 * Close specified popup and any popups that it parented.
1968 1968 * If no popup is specified, closes all popups.
1969 1969 */
1970 1970 close(popup?: _WidgetBase): void;
1971 1971 }
1972 1972
1973 1973 /* dijit/PopupMenuBarItem */
1974 1974
1975 1975 interface PopupMenuBarItem extends PopupMenuItem { }
1976 1976
1977 1977 interface PopupMenuBarItemConstructor extends _WidgetBaseConstructor<PopupMenuBarItem> { }
1978 1978
1979 1979 /** dijit/PopupMenuItem */
1980 1980
1981 1981 /**
1982 1982 * An item in a Menu that spawn a drop down (usually a drop down menu)
1983 1983 */
1984 1984 interface PopupMenuItem extends MenuItem {
1985 1985 /**
1986 1986 * When Menu is declared in markup, this code gets the menu label and the popup widget from the srcNodeRef.
1987 1987 *
1988 1988 * srcNodeRef.innerHTML contains both the menu item text and a popup widget
1989 1989 * The first part holds the menu item text and the second part is the popup
1990 1990 */
1991 1991 _fillContent(source: Element): void;
1992 1992
1993 1993 /**
1994 1994 * Open the popup to the side of/underneath this MenuItem, and optionally focus first item
1995 1995 */
1996 1996 _openPopup(params: { around?: Element; popup?: Function }, focus?: boolean): void;
1997 1997
1998 1998 _closePopup(): void;
1999 1999 }
2000 2000
2001 2001 interface PopupMenuItemConstructor extends _WidgetBaseConstructor<PopupMenuItem> { }
2002 2002
2003 2003 /* dijit/registry */
2004 2004
2005 2005 interface Registry {
2006 2006 /**
2007 2007 * Number of registered widgets
2008 2008 */
2009 2009 length: number;
2010 2010
2011 2011 /**
2012 2012 * Add a widget to the registry. If a duplicate ID is detected, a error is thrown.
2013 2013 */
2014 2014 add(widget: _WidgetBase): void;
2015 2015
2016 2016 /**
2017 2017 * Remove a widget from the registry. Does not destroy the widget; simply
2018 2018 * removes the reference.
2019 2019 */
2020 2020 remove(id: string): void;
2021 2021
2022 2022 /**
2023 2023 * Find a widget by it's id.
2024 2024 * If passed a widget then just returns the widget.
2025 2025 */
2026 2026 byId(id: string | _WidgetBase): _WidgetBase;
2027 2027
2028 2028 /**
2029 2029 * Returns the widget corresponding to the given DOMNode
2030 2030 */
2031 2031 byNode(node: Element | Node): _WidgetBase;
2032 2032
2033 2033 /**
2034 2034 * Convert registry into a true Array
2035 2035 */
2036 2036 toArray(): _WidgetBase[];
2037 2037
2038 2038 /**
2039 2039 * Generates a unique id for a given widgetType
2040 2040 */
2041 2041 getUniqueId(widgetType: string): string;
2042 2042
2043 2043 /**
2044 2044 * Search subtree under root returning widgets found.
2045 2045 * Doesn't search for nested widgets (ie, widgets inside other widgets).
2046 2046 */
2047 2047 findWidgets(root: Node, skipNode?: Node): _WidgetBase[];
2048 2048
2049 2049 /**
2050 2050 * Returns the widget whose DOM tree contains the specified DOMNode, or null if
2051 2051 * the node is not contained within the DOM tree of any widget
2052 2052 */
2053 2053 getEnclosingWidget(node: Element | Node): _WidgetBase;
2054 2054 }
2055 2055
2056 2056 /* dijit/TitlePane */
2057 2057
2058 2058 interface TitlePane extends dijit.layout.ContentPane, _TemplatedMixin, _CssStateMixin {
2059 2059 /**
2060 2060 * Whether pane can be opened or closed by clicking the title bar.
2061 2061 */
2062 2062 toggleable: boolean;
2063 2063
2064 2064 /**
2065 2065 * Tabindex setting for the title (so users can tab to the title then use space/enter to open/close the title pane)
2066 2066 */
2067 2067 tabIndex: string;
2068 2068
2069 2069 /**
2070 2070 * Time in milliseconds to fade in/fade out
2071 2071 */
2072 2072 duration: number;
2073 2073
2074 2074 /**
2075 2075 * Don't change this parameter from the default value.
2076 2076 *
2077 2077 * This ContentPane parameter doesn't make sense for TitlePane, since TitlePane is never a child of a layout container, nor should TitlePane try to control the size of an inner widget.
2078 2078 */
2079 2079 doLayout: boolean;
2080 2080
2081 2081 /**
2082 2082 * Switches between opened and closed state
2083 2083 */
2084 2084 toggle(): void;
2085 2085
2086 2086 /**
2087 2087 * Set the open/close css state for the TitlePane
2088 2088 */
2089 2089 _setCss(): void;
2090 2090
2091 2091 /**
2092 2092 * Handler for when user hits a key
2093 2093 */
2094 2094 _onTitleKey(e: Event): void;
2095 2095
2096 2096 /**
2097 2097 * Handler when user clicks the title bar
2098 2098 */
2099 2099 _onTitleClick(): void;
2100 2100
2101 2101 /**
2102 2102 * Deprecated. Use set('title', ...) instead.
2103 2103 */
2104 2104 setTitle(): void;
2105 2105 }
2106 2106
2107 2107 interface TitlePaneConstructor extends _WidgetBaseConstructor<TitlePane> { }
2108 2108
2109 2109 /* dijit/Toolbar */
2110 2110
2111 2111 interface Toolbar extends dijit._Widget, dijit._TemplatedMixin, dijit._KeyNavContainer { }
2112 2112
2113 2113 interface ToolbarConstructor extends _WidgetBaseConstructor<Toolbar> { }
2114 2114
2115 2115 /* dijit/ToolbarSeparator */
2116 2116
2117 2117 interface ToolbarSeparator extends dijit._Widget, dijit._TemplatedMixin { }
2118 2118
2119 2119 interface ToolbarSeparatorConstructor extends _WidgetBaseConstructor<ToolbarSeparator> { }
2120 2120
2121 2121 /* dijit/Tooltip */
2122 2122
2123 2123 interface Tooltip extends _Widget {
2124 2124 /**
2125 2125 * HTML to display in the tooltip.
2126 2126 * Specified as innerHTML when creating the widget from markup.
2127 2127 */
2128 2128 label: string;
2129 2129
2130 2130 /**
2131 2131 * Number of milliseconds to wait after hovering over/focusing on the object, before
2132 2132 * the tooltip is displayed.
2133 2133 */
2134 2134 showDelay: number;
2135 2135
2136 2136 /**
2137 2137 * Number of milliseconds to wait after unhovering the object, before
2138 2138 * the tooltip is hidden. Note that blurring an object hides the tooltip immediately.
2139 2139 */
2140 2140 hideDelay: number;
2141 2141
2142 2142 /**
2143 2143 * Id of domNode(s) to attach the tooltip to.
2144 2144 * When user hovers over specified dom node(s), the tooltip will appear.
2145 2145 */
2146 2146 connectId: dojo.NodeOrString | dojo.NodeOrString[];
2147 2147
2148 2148 /**
2149 2149 * See description of `dijit/Tooltip.defaultPosition` for details on position parameter.
2150 2150 */
2151 2151 position: string;
2152 2152
2153 2153 /**
2154 2154 * CSS expression to apply this Tooltip to descendants of connectIds, rather than to
2155 2155 * the nodes specified by connectIds themselves. Useful for applying a Tooltip to
2156 2156 * a range of rows in a table, tree, etc. Use in conjunction with getContent() parameter.
2157 2157 * Ex: connectId: myTable, selector: "tr", getContent: function(node){ return ...; }
2158 2158 *
2159 2159 * The application must require() an appropriate level of dojo/query to handle the selector.
2160 2160 */
2161 2161 selector: string;
2162 2162
2163 2163 /**
2164 2164 * Attach tooltip to specified node if it's not already connected
2165 2165 */
2166 2166 addTarget(node: dojo.NodeOrString): void;
2167 2167
2168 2168 /**
2169 2169 * Detach tooltip from specified node
2170 2170 */
2171 2171 removeTarget(node: dojo.NodeOrString): void;
2172 2172
2173 2173 /**
2174 2174 * User overridable function that return the text to display in the tooltip.
2175 2175 */
2176 2176 getContent(node: Node): Node;
2177 2177
2178 2178 /**
2179 2179 * Display the tooltip; usually not called directly.
2180 2180 */
2181 2181 open(target: Node): void;
2182 2182
2183 2183 /**
2184 2184 * Hide the tooltip or cancel timer for show of tooltip
2185 2185 */
2186 2186 close(): void;
2187 2187
2188 2188 /**
2189 2189 * Called when the tooltip is shown
2190 2190 */
2191 2191 onShow(): void;
2192 2192
2193 2193 /**
2194 2194 * Called when the tooltip is hidden
2195 2195 */
2196 2196 onHide(): void;
2197 2197 }
2198 2198
2199 2199 interface TooltipConstructor extends _WidgetBaseConstructor<Tooltip> {
2200 2200 /**
2201 2201 * This variable controls the position of tooltips, if the position is not specified to
2202 2202 * the Tooltip widget or *TextBox widget itself. It's an array of strings with the values
2203 2203 * possible for `dijit/place.around()`. The recommended values are:
2204 2204 *
2205 2205 * - before-centered: centers tooltip to the left of the anchor node/widget, or to the right
2206 2206 * in the case of RTL scripts like Hebrew and Arabic
2207 2207 * - after-centered: centers tooltip to the right of the anchor node/widget, or to the left
2208 2208 * in the case of RTL scripts like Hebrew and Arabic
2209 2209 * - above-centered: tooltip is centered above anchor node
2210 2210 * - below-centered: tooltip is centered above anchor node
2211 2211 *
2212 2212 * The list is positions is tried, in order, until a position is found where the tooltip fits
2213 2213 * within the viewport.
2214 2214 *
2215 2215 * Be careful setting this parameter. A value of "above-centered" may work fine until the user scrolls
2216 2216 * the screen so that there's no room above the target node. Nodes with drop downs, like
2217 2217 * DropDownButton or FilteringSelect, are especially problematic, in that you need to be sure
2218 2218 * that the drop down and tooltip don't overlap, even when the viewport is scrolled so that there
2219 2219 * is only room below (or above) the target node, but not both.
2220 2220 */
2221 2221 defaultPosition: [string];
2222 2222
2223 2223 /**
2224 2224 * Static method to display tooltip w/specified contents in specified position.
2225 2225 * See description of dijit/Tooltip.defaultPosition for details on position parameter.
2226 2226 * If position is not specified then dijit/Tooltip.defaultPosition is used.
2227 2227 */
2228 2228 show(innerHTML: string, aroundNode: PlaceRectangle, position?: [string], rtl?: boolean, textDir?: string, onMouseEnter?: Function, onMouseLeave?: Function): void;
2229 2229
2230 2230 /**
2231 2231 * Hide the tooltip
2232 2232 */
2233 2233 hide(aroundNode: PlaceRectangle): void;
2234 2234 }
2235 2235
2236 2236 /* dijit/TooltipDialog */
2237 2237
2238 2238 interface TooltipDialog extends layout.ContentPane, _TemplatedMixin, form._FormMixin, _DialogMixin {
2239 2239 /**
2240 2240 * Description of tooltip dialog (required for a11y)
2241 2241 */
2242 2242 title: string;
2243 2243
2244 2244 /**
2245 2245 * Don't change this parameter from the default value.
2246 2246 * This ContentPane parameter doesn't make sense for TooltipDialog, since TooltipDialog
2247 2247 * is never a child of a layout container, nor can you specify the size of
2248 2248 * TooltipDialog in order to control the size of an inner widget.
2249 2249 */
2250 2250 doLayout: boolean;
2251 2251
2252 2252 /**
2253 2253 * A Toggle to modify the default focus behavior of a Dialog, which
2254 2254 * is to focus on the first dialog element after opening the dialog.
2255 2255 * False will disable autofocusing. Default: true.
2256 2256 */
2257 2257 autofocus: boolean;
2258 2258
2259 2259 /**
2260 2260 * The pointer to the first focusable node in the dialog.
2261 2261 */
2262 2262 _firstFocusItem: any;
2263 2263
2264 2264 /**
2265 2265 * The pointer to which node has focus prior to our dialog.
2266 2266 */
2267 2267 _lastFocusItem: any;
2268 2268
2269 2269 /**
2270 2270 * Configure widget to be displayed in given position relative to the button.
2271 2271 *
2272 2272 * This is called from the dijit.popup code, and should not be called directly.
2273 2273 */
2274 2274 orient(node: Node | HTMLElement, aroundCorner: PlaceCorner, tooltipCorner: PlaceCorner): void;
2275 2275
2276 2276 /**
2277 2277 * Focus on first field
2278 2278 */
2279 2279 focus(): void;
2280 2280
2281 2281 /**
2282 2282 * Called when dialog is displayed.
2283 2283 *
2284 2284 * This is called from the dijit.popup code, and should not be called directly.
2285 2285 */
2286 2286 onOpen(pos: {
2287 2287 aroundCorner: PlaceCorner
2288 2288 aroundNodePos: PlacePosition
2289 2289 corner: PlaceCorner
2290 2290 x: number
2291 2291 y: number
2292 2292 }): void;
2293 2293
2294 2294 /**
2295 2295 * Handler for keydown events
2296 2296 *
2297 2297 * Keep keyboard focus in dialog; close dialog on escape key
2298 2298 */
2299 2299 _onKey(evt: KeyboardEvent): void;
2300 2300 }
2301 2301
2302 2302 interface TooltipDialogConstructor extends _WidgetBaseConstructor<TooltipDialog> { }
2303 2303 }
Show file before | Show file after | Hide comments
@@ -1,481 +1,487
1 1 /// <reference path="index.d.ts" />
2 2
3 3 declare module 'dijit/_Widget' {
4 4 type _Widget = dijit._Widget;
5 5 const _Widget: dijit._WidgetBaseConstructor<_Widget>;
6 6 export = _Widget;
7 7 }
8 8
9 9 declare module 'dijit/_WidgetBase' {
10 type _WidgetBase = dijit._WidgetBase;
11 const _WidgetBase: dijit._WidgetBaseConstructor<_WidgetBase>;
10 type _WidgetBase<A = any> = dijit._WidgetBase<A>;
11
12 // individual _WidgetBase constructor to keep type parameters
13 interface _WidgetBaseConstructor {
14 new <A = any>(params?: Partial<_WidgetBase<A> & A>, srcNodeRef?: dojo.NodeOrString): _WidgetBase<A> & dojo._base.DeclareCreatedObject;
15 prototype: _WidgetBase;
16 }
17 const _WidgetBase: _WidgetBaseConstructor;
12 18 export = _WidgetBase;
13 19 }
14 20
15 21 declare module 'dijit/_AttachMixin' {
16 22 type _AttachMixin = dijit._AttachMixin;
17 23 const _AttachMixin: dijit._AttachMixinConstructor;
18 24 export = _AttachMixin;
19 25 }
20 26
21 27 declare module 'dijit/_CssStateMixin' {
22 28 type _CssStateMixin = dijit._CssStateMixin;
23 29 const _CssStateMixin: dijit._CssStateMixinConstructor;
24 30 export = _CssStateMixin;
25 31 }
26 32
27 33 declare module 'dijit/_Contained' {
28 34 type _Contained = dijit._Contained;
29 35 const _Contained: dijit._ContainedConstructor;
30 36 export = _Contained;
31 37 }
32 38
33 39 declare module 'dijit/_Container' {
34 40 type _Container = dijit._Container;
35 41 const _Container: dijit._ContainerConstructor;
36 42 export = _Container;
37 43 }
38 44
39 45 declare module 'dijit/_KeyNavContainer' {
40 46 type _KeyNavContainer = dijit._KeyNavContainer;
41 47 const _KeyNavContainer: dijit._KeyNavContainerConstructor;
42 48 export = _KeyNavContainer;
43 49 }
44 50
45 51 declare module 'dijit/_KeyNavMixin' {
46 52 type _KeyNavMixin = dijit._KeyNavMixin;
47 53 const _KeyNavMixin: dijit._KeyNavMixinConstructor;
48 54 export = _KeyNavMixin;
49 55 }
50 56
51 57 declare module 'dijit/_MenuBase' {
52 58 type _MenuBase = dijit._MenuBase;
53 59 const _MenuBase: dijit._MenuBaseConstructor;
54 60 export = _MenuBase;
55 61 }
56 62
57 63 declare module 'dijit/_TemplatedMixin' {
58 64 type _TemplatedMixin = dijit._TemplatedMixin;
59 65 const _TemplatedMixin: dijit._TemplatedMixinConstructor;
60 66 export = _TemplatedMixin;
61 67 }
62 68
63 69 declare module 'dijit/_WidgetsInTemplateMixin' {
64 70 type _WidgetsInTemplateMixin = dijit._WidgetsInTemplateMixin;
65 71 const _WidgetsInTemplateMixin: dijit._WidgetsInTemplateMixinConstructor;
66 72 export = _WidgetsInTemplateMixin;
67 73 }
68 74
69 75 declare module 'dijit/ConfirmDialog' {
70 76 type ConfirmDialog = dijit.ConfirmDialog;
71 77 const ConfirmDialog: dijit.ConfirmDialogConstructor;
72 78 export = ConfirmDialog;
73 79 }
74 80
75 81 declare module 'dijit/Calendar' {
76 82 type Calendar = dijit.Calendar;
77 83 const Calendar: dijit.CalendarConstructor;
78 84 export = Calendar;
79 85 }
80 86
81 87 declare module 'dijit/CalendarLite' {
82 88 type CalendarLite = dijit.CalendarLite;
83 89 const CalendarLite: dijit.CalendarLiteConstructor;
84 90 export = CalendarLite;
85 91 }
86 92
87 93 declare module 'dijit/Destroyable' {
88 94 type Destroyable = dijit.Destroyable;
89 95 const Destroyable: dijit.DestroyableConstructor;
90 96 export = Destroyable;
91 97 }
92 98
93 99 declare module 'dijit/Dialog' {
94 100 type Dialog = dijit.Dialog;
95 101 const Dialog: dijit.DialogConstructor;
96 102 export = Dialog;
97 103 }
98 104
99 105 declare module 'dijit/DropDownMenu' {
100 106 type DropDownMenu = dijit.DropDownMenu;
101 107 const DropDownMenu: dijit.DropDownMenuConstructor;
102 108 export = DropDownMenu;
103 109 }
104 110
105 111 declare module 'dijit/Fieldset' {
106 112 type Fieldset = dijit.Fieldset;
107 113 const Fieldset: dijit.FieldsetConstructor;
108 114 export = Fieldset;
109 115 }
110 116
111 117 declare module 'dijit/Menu' {
112 118 type Menu = dijit.Menu;
113 119 const Menu: dijit.MenuConstructor;
114 120 export = Menu;
115 121 }
116 122
117 123 declare module 'dijit/MenuBar' {
118 124 type MenuBar = dijit.MenuBar;
119 125 const MenuBar: dijit.MenuBarConstructor;
120 126 export = MenuBar;
121 127 }
122 128
123 129 declare module 'dijit/MenuBarItem' {
124 130 type MenuBarItem = dijit.MenuBarItem;
125 131 const MenuBarItem: dijit.MenuBarItemConstructor;
126 132 export = MenuBarItem;
127 133 }
128 134
129 135 declare module 'dijit/MenuItem' {
130 136 type MenuItem = dijit.MenuItem;
131 137 const MenuItem: dijit.MenuItemConstructor;
132 138 export = MenuItem;
133 139 }
134 140
135 141 declare module 'dijit/MenuSeparator' {
136 142 type MenuSeparator = dijit.MenuSeparator;
137 143 const MenuSeparator: dijit.MenuSeparatorConstructor;
138 144 export = MenuSeparator;
139 145 }
140 146
141 147 declare module 'dijit/place' {
142 148 const place: dijit.Place;
143 149 export = place;
144 150 }
145 151
146 152 declare module 'dijit/popup' {
147 153 const popup: dijit.PopupManager;
148 154 export = popup;
149 155 }
150 156
151 157 declare module 'dijit/PopupMenuBarItem' {
152 158 type PopupMenuBarItem = dijit.PopupMenuBarItem;
153 159 const PopupMenuBarItem: dijit.PopupMenuBarItemConstructor;
154 160 export = PopupMenuBarItem;
155 161 }
156 162
157 163 declare module 'dijit/PopupMenuItem' {
158 164 type PopupMenuItem = dijit.PopupMenuItem;
159 165 const PopupMenuItem: dijit.PopupMenuItemConstructor;
160 166 export = PopupMenuItem;
161 167 }
162 168
163 169 declare module 'dijit/registry' {
164 170 const registry: dijit.Registry;
165 171 export = registry;
166 172 }
167 173
168 174 declare module 'dijit/TitlePane' {
169 175 type TitlePane = dijit.TitlePane;
170 176 const TitlePane: dijit.TitlePaneConstructor;
171 177 export = TitlePane;
172 178 }
173 179
174 180 declare module 'dijit/Toolbar' {
175 181 type Toolbar = dijit.Toolbar;
176 182 const Toolbar: dijit.ToolbarConstructor;
177 183 export = Toolbar;
178 184 }
179 185
180 186 declare module 'dijit/ToolbarSeparator' {
181 187 type ToolbarSeparator = dijit.ToolbarSeparator;
182 188 const ToolbarSeparator: dijit.ToolbarSeparatorConstructor;
183 189 export = ToolbarSeparator;
184 190 }
185 191
186 192 declare module 'dijit/Tooltip' {
187 193 type Tooltip = dijit.Tooltip;
188 194 const Tooltip: dijit.TooltipConstructor;
189 195 export = Tooltip;
190 196 }
191 197
192 198 declare module 'dijit/TooltipDialog' {
193 199 type TooltipDialog = dijit.TooltipDialog;
194 200 const TooltipDialog: dijit.TooltipDialogConstructor;
195 201 export = TooltipDialog;
196 202 }
197 203
198 204 declare module 'dijit/_base/focus' {
199 205 const focus: dijit._base.Focus;
200 206 export = focus;
201 207 }
202 208
203 209 declare module 'dijit/_base/manager' {
204 210 const manager: dijit._base.Manager;
205 211 export = manager;
206 212 }
207 213
208 214 declare module 'dijit/_base/place' {
209 215 const place: dijit._base.Place;
210 216 export = place;
211 217 }
212 218
213 219 declare module 'dijit/_base/popup' {
214 220 const popup: dijit._base.Popup;
215 221 export = popup;
216 222 }
217 223
218 224 declare module 'dijit/_base/scroll' {
219 225 const scroll: dijit._base.Scroll;
220 226 export = scroll;
221 227 }
222 228
223 229 declare module 'dijit/_base/sniff' {
224 230 const sniff: dijit._base.Sniff;
225 231 export = sniff;
226 232 }
227 233
228 234 declare module 'dijit/_base/typematic' {
229 235 const typematic: dijit._base.Typematic;
230 236 export = typematic;
231 237 }
232 238
233 239 declare module 'dijit/_base/wai' {
234 240 const wai: dijit._base.Wai;
235 241 export = wai;
236 242 }
237 243
238 244 declare module 'dijit/_base/window' {
239 245 const window: dijit._base.Window;
240 246 export = window;
241 247 }
242 248
243 249 declare module 'dijit/form/_FormMixin' {
244 250 type _FormMixin = dijit.form._FormMixin;
245 251 const _FormMixin: dijit.form._FormMixinConstructor;
246 252 export = _FormMixin;
247 253 }
248 254
249 255 declare module 'dijit/form/_FormValueWidget' {
250 256 type _FormValueWidget = dijit.form._FormValueWidget;
251 257 const _FormValueWidget: dijit.form._FormValueWidgetConstructor;
252 258 export = _FormValueWidget;
253 259 }
254 260
255 261 declare module 'dijit/form/_FormWidget' {
256 262 type _FormWidget = dijit.form._FormWidget;
257 263 const _FormWidget: dijit.form._FormWidgetConstructor;
258 264 export = _FormWidget;
259 265 }
260 266
261 267 declare module 'dijit/form/Button' {
262 268 type Button = dijit.form.Button;
263 269 const Button: dijit.form.ButtonConstructor;
264 270 export = Button;
265 271 }
266 272
267 273 declare module 'dijit/form/CheckBox' {
268 274 type CheckBox = dijit.form.CheckBox;
269 275 const CheckBox: dijit.form.CheckBoxConstructor;
270 276 export = CheckBox;
271 277 }
272 278
273 279 declare module 'dijit/form/ComboBox' {
274 280 type ComboBox = dijit.form.TextBox;
275 281 const ComboBox: dijit.form.ComboBoxConstructor;
276 282 export = ComboBox;
277 283 }
278 284
279 285 declare module 'dijit/form/ComboBoxMixin' {
280 286 type ComboBoxMixin<T, U extends dojo.store.api.BaseQueryType, V> = dijit.form.ComboBoxMixin<T, U, V>;
281 287 const ComboBoxMixin: dijit.form.ComboBoxConstructor;
282 288 export = ComboBoxMixin;
283 289 }
284 290
285 291 declare module 'dijit/form/CurrencyTextBox' {
286 292 type CurrencyTextBox = dijit.form.CurrencyTextBox;
287 293 const CurrencyTextBox: dijit.form.CurrencyTextBoxConstructor;
288 294 export = CurrencyTextBox;
289 295 }
290 296
291 297 declare module 'dijit/form/DataList' {
292 298 type DataList<T> = dijit.form.DataList<T>;
293 299 const DataList: dijit.form.DataListConstructor;
294 300 export = DataList;
295 301 }
296 302
297 303 declare module 'dijit/form/DateTextBox' {
298 304 type DateTextBox = dijit.form.DateTextBox;
299 305 const DateTextBox: dijit.form.DateTextBoxConstructor;
300 306 export = DateTextBox;
301 307 }
302 308
303 309 declare module 'dijit/form/DropDownButton' {
304 310 type DropDownButton<T extends dijit._WidgetBase> = dijit.form.DropDownButton<T>;
305 311 const DropDownButton: dijit.form.DropDownButtonConstructor;
306 312 export = DropDownButton;
307 313 }
308 314
309 315 declare module 'dijit/form/FilteringSelect' {
310 316 type FilteringSelect<C extends dijit.form.Constraints, T extends Object, Q extends string | Object | Function, O extends dojo.store.api.QueryOptions> = dijit.form.FilteringSelect<C, T, Q, O>;
311 317 const FilteringSelect: dijit.form.FilteringSelectConstructor;
312 318 export = FilteringSelect;
313 319 }
314 320
315 321 declare module 'dijit/form/Form' {
316 322 type Form = dijit.form.Form;
317 323 const Form: dijit.form.FormConstructor;
318 324 export = Form;
319 325 }
320 326
321 327 declare module 'dijit/form/HorizontalRule' {
322 328 type HorizontalRule = dijit.form.HorizontalRule;
323 329 const HorizontalRule: dijit.form.HorizontalRuleConstructor;
324 330 export = HorizontalRule;
325 331 }
326 332
327 333 declare module 'dijit/form/HorizontalRuleLabels' {
328 334 type HorizontalRuleLabels = dijit.form.HorizontalRuleLabels;
329 335 const HorizontalRuleLabels: dijit.form.HorizontalRuleLabelsConstructor;
330 336 export = HorizontalRuleLabels;
331 337 }
332 338
333 339 declare module 'dijit/form/HorizontalSlider' {
334 340 type HorizontalSlider = dijit.form.HorizontalSlider;
335 341 const HorizontalSlider: dijit.form.HorizontalSliderConstructor;
336 342 export = HorizontalSlider;
337 343 }
338 344
339 345 declare module 'dijit/form/MappedTextBox' {
340 346 type MappedTextBox<C extends dijit.form.Constraints> = dijit.form.MappedTextBox<C>;
341 347 const MappedTextBox: dijit.form.MappedTextBoxConstructor;
342 348 export = MappedTextBox;
343 349 }
344 350
345 351 declare module 'dijit/form/NumberSpinner' {
346 352 type NumberSpinner = dijit.form.NumberSpinner;
347 353 const NumberSpinner: dijit.form.NumberSpinnerConstructor;
348 354 export = NumberSpinner;
349 355 }
350 356
351 357 declare module 'dijit/form/NumberTextBox' {
352 358 type NumberTextBox = dijit.form.NumberTextBox;
353 359 const NumberTextBox: dijit.form.NumberTextBoxConstructor;
354 360 export = NumberTextBox;
355 361 }
356 362
357 363 declare module 'dijit/form/RadioButton' {
358 364 type RadioButton = dijit.form.RadioButton;
359 365 const RadioButton: dijit.form.RadioButtonConstructor;
360 366 export = RadioButton;
361 367 }
362 368
363 369 declare module 'dijit/form/RangeBoundTextBox' {
364 370 type RangeBoundTextBox = dijit.form.RangeBoundTextBox;
365 371 const RangeBoundTextBox: dijit.form.RangeBoundTextBoxConstructor;
366 372 export = RangeBoundTextBox;
367 373 }
368 374
369 375 declare module 'dijit/form/Select' {
370 376 type Select<T, Q extends dojo.store.api.BaseQueryType, O, U extends dijit._WidgetBase> = dijit.form.Select<T, Q, O, U>;
371 377 const Select: dijit.form.SelectConstructor;
372 378 export = Select;
373 379 }
374 380
375 381 declare module 'dijit/form/SimpleTextarea' {
376 382 type SimpleTextarea = dijit.form.SimpleTextarea;
377 383 const SimpleTextarea: dijit.form.SimpleTextareaConstructor;
378 384 export = SimpleTextarea;
379 385 }
380 386
381 387 declare module 'dijit/form/Textarea' {
382 388 type Textarea = dijit.form.Textarea;
383 389 const Textarea: dijit.form.TextareaConstructor;
384 390 export = Textarea;
385 391 }
386 392
387 393 declare module 'dijit/form/TextBox' {
388 394 type TextBox = dijit.form.TextBox;
389 395 const TextBox: dijit.form.TextBoxConstructor;
390 396 export = TextBox;
391 397 }
392 398
393 399 declare module 'dijit/form/ToggleButton' {
394 400 type ToggleButton = dijit.form.ToggleButton;
395 401 const ToggleButton: dijit.form.ToggleButtonConstructor;
396 402 export = ToggleButton;
397 403 }
398 404
399 405 declare module 'dijit/form/ValidationTextBox' {
400 406 type ValidationTextBox<C extends dijit.form.Constraints> = dijit.form.ValidationTextBox<C>;
401 407 const ValidationTextBox: dijit.form.ValidationTextBoxConstructor;
402 408 export = ValidationTextBox;
403 409 }
404 410
405 411 declare module 'dijit/layout/_LayoutWidget' {
406 412 type _LayoutWidget = dijit.layout._LayoutWidget;
407 413 const _LayoutWidget: dijit.layout._LayoutWidgetConstructor;
408 414 export = _LayoutWidget;
409 415 }
410 416
411 417 declare module 'dijit/layout/AccordionContainer' {
412 418 type AccordionContainer = dijit.layout.AccordionContainer;
413 419 const AccordionContainer: dijit.layout.AccordionContainerConstructor;
414 420 export = AccordionContainer;
415 421 }
416 422
417 423 declare module 'dijit/layout/AccordionPane' {
418 424 type AccordionPane = dijit.layout.AccordionPane;
419 425 const AccordionPane: dijit.layout.AccordionPaneConstructor;
420 426 export = AccordionPane;
421 427 }
422 428
423 429 declare module 'dijit/layout/ContentPane' {
424 430 type ContentPane = dijit.layout.ContentPane;
425 431 const ContentPane: dijit.layout.ContentPaneConstructor;
426 432 export = ContentPane;
427 433 }
428 434
429 435 declare module 'dijit/layout/_ContentPaneResizeMixin' {
430 436 type _ContentPaneResizeMixin = dijit.layout._ContentPaneResizeMixin;
431 437 const _ContentPaneResizeMixin: dijit.layout._ContentPaneResizeMixinConstructor;
432 438 export = _ContentPaneResizeMixin;
433 439 }
434 440
435 441 declare module 'dijit/layout/BorderContainer' {
436 442 type BorderContainer = dijit.layout.BorderContainer;
437 443 const BorderContainer: dijit.layout.BorderContainerConstructor;
438 444 export = BorderContainer;
439 445 }
440 446
441 447 declare module 'dijit/layout/LayoutContainer' {
442 448 type LayoutContainer = dijit.layout.LayoutContainer;
443 449 const LayoutContainer: dijit.layout.LayoutContainerConstructor;
444 450 export = LayoutContainer;
445 451 }
446 452
447 453 declare module 'dijit/layout/LinkPane' {
448 454 type LinkPane = dijit.layout.LinkPane;
449 455 const LinkPane: dijit.layout.LinkPaneConstructor;
450 456 export = LinkPane;
451 457 }
452 458
453 459 declare module 'dijit/layout/ScrollingTabController' {
454 460 type ScrollingTabController = dijit.layout.ScrollingTabController;
455 461 const ScrollingTabController: dijit.layout.ScrollingTabControllerConstructor;
456 462 export = ScrollingTabController;
457 463 }
458 464
459 465 declare module 'dijit/layout/StackContainer' {
460 466 type StackContainer = dijit.layout.StackContainer;
461 467 const StackContainer: dijit.layout.StackContainerConstructor;
462 468 export = StackContainer;
463 469 }
464 470
465 471 declare module 'dijit/layout/StackController' {
466 472 type StackController = dijit.layout.StackController;
467 473 const StackController: dijit.layout.StackControllerConstructor;
468 474 export = StackController;
469 475 }
470 476
471 477 declare module 'dijit/layout/TabContainer' {
472 478 type TabContainer = dijit.layout.TabContainer;
473 479 const TabContainer: dijit.layout.TabContainerConstructor;
474 480 export = TabContainer;
475 481 }
476 482
477 483 declare module 'dijit/layout/TabController' {
478 484 type TabController = dijit.layout.TabController;
479 485 const TabController: dijit.layout.TabControllerConstructor;
480 486 export = TabController;
481 487 }
Show file before | Show file after | Hide comments
@@ -1,21 +1,28
1 import Memory = require("dojo/store/Memory");
1 2 import Observable = require("dojo/store/Observable");
2 3
3 4 interface Schedule {
4 5
5 id: string;
6 id?: string;
6 7
7 8 title: string;
8 9
9 10 duration: number;
10 11 }
11 12
12 13 declare const store: dojo.store.api.Store<Schedule>;
13 14
14 15 const observable = new Observable(store);
15 16
17 const mem = new Memory<Schedule>();
18
16 19 (async () => {
17 20 observable.query().observe(() => {});
18 21 store.query().forEach(() => {});
19 22 const total = await store.query().total;
20 23 const result = await store.query();
24
25 mem.query();
26
27 mem.add({duration: 10, title: "Test event"});
21 28 })(); No newline at end of file
General Comments 0
You need to be logged in to leave comments. Login now