ContentPane.d.ts
189 lines
| 5.7 KiB
| video/mp2t
|
TypeScriptLexer
cin
|
r2 | import { _WidgetBaseConstructor } from "dijit/_WidgetBase"; | ||
| import { Deferred } from "dojo/Deferred"; | ||||
| import { ContentSetterContent } from "dojo/html"; | ||||
| import { GenericConstructor } from "dojo/interfaces"; | ||||
| import { DojoRequestPromise, XhrBaseOptions } from "dojo/request"; | ||||
| import _Widget = require("dijit/_Widget"); | ||||
| import _Container = require("dijit/_Container"); | ||||
| import _ContentPaneResizeMixin = require("./_ContentPaneResizeMixin"); | ||||
| interface ContentPane extends _Widget, _Container, _ContentPaneResizeMixin { | ||||
| /** | ||||
| * The href of the content that displays now | ||||
| * Set this at construction if you want to load data externally when th | ||||
| * pane is shown. (Set preload=true to load it immediately. | ||||
| * Changing href after creation doesn't have any effect; Use set('href', ...); | ||||
| */ | ||||
| href: string; | ||||
| /** | ||||
| * The innerHTML of the ContentPane | ||||
| * Note that the initialization parameter / argument to set("content", ... | ||||
| * can be a String, DomNode, Nodelist, or _Widget. | ||||
| */ | ||||
| content: ContentSetterContent | _Widget; | ||||
| /** | ||||
| * Extract visible content from inside of `<body> .... </body>` | ||||
| * I.e., strip `<html>` and `<head>` (and it's contents) from the href | ||||
| */ | ||||
| extractContent: boolean; | ||||
| /** | ||||
| * Parse content and create the widgets, if any. | ||||
| */ | ||||
| parseOnLoad: boolean; | ||||
| /** | ||||
| * Flag passed to parser. Root for attribute names to search for. If scopeName is dojo | ||||
| * will search for data-dojo-type (or dojoType). For backwards compatibilit | ||||
| * reasons defaults to dojo._scopeName (which is "dojo" except whe | ||||
| * multi-version support is used, when it will be something like dojo16, dojo20, etc.) | ||||
| */ | ||||
| parserScope: string; | ||||
| /** | ||||
| * Prevent caching of data from href's by appending a timestamp to the href. | ||||
| */ | ||||
| preventCache: boolean; | ||||
| /** | ||||
| * Force load of data on initialization even if pane is hidden. | ||||
| */ | ||||
| preload: boolean; | ||||
| /** | ||||
| * Refresh (re-download) content when pane goes from hidden to shown | ||||
| */ | ||||
| refreshOnShow: boolean; | ||||
| /** | ||||
| * Message that shows while downloading | ||||
| */ | ||||
| loadingMessage: string; | ||||
| /** | ||||
| * Message that shows if an error occurs | ||||
| */ | ||||
| errorMessage: string; | ||||
| /** | ||||
| * True if the ContentPane has data in it, either specifie | ||||
| * during initialization (via href or inline content), or se | ||||
| * via set('content', ...) / set('href', ... | ||||
| * False if it doesn't have any content, or if ContentPane i | ||||
| * still in the process of downloading href. | ||||
| */ | ||||
| isLoaded: boolean; | ||||
| baseClass: string; | ||||
| /** | ||||
| * Function that should grab the content specified via href. | ||||
| */ | ||||
| ioMethod<T>(url: string, options?: XhrBaseOptions): DojoRequestPromise<T>; | ||||
| /** | ||||
| * Parameters to pass to xhrGet() request, for example: | ||||
| * | <div data-dojo-type="dijit/layout/ContentPane" data-dojo-props="href: './bar', ioArgs: {timeout: 500}"> | ||||
| */ | ||||
| ioArgs: { [arg: string]: string | number }; | ||||
| /** | ||||
| * This is the `dojo.Deferred` returned by set('href', ...) and refresh() | ||||
| * Calling onLoadDeferred.then() registers you | ||||
| * callback to be called only once, when the prior set('href', ...) call o | ||||
| * the initial href parameter to the constructor finishes loading | ||||
| * This is different than an onLoad() handler which gets called any time any hre | ||||
| * or content is loaded. | ||||
| */ | ||||
| onLoadDeferred: Deferred<any>; | ||||
| /** | ||||
| * Flag to parser that I'll parse my contents, so it shouldn't. | ||||
| */ | ||||
| stopParser: boolean; | ||||
| /** | ||||
| * Flag from the parser that this ContentPane is inside a templat | ||||
| * so the contents are pre-parsed. | ||||
| */ | ||||
| template: boolean; | ||||
| markupFactory<T>(params: any, node: HTMLElement, ctor: GenericConstructor<T>): T; | ||||
| postMixInProperties(): void; | ||||
| buildRendering(): void; | ||||
| /** | ||||
| * Call startup() on all children including non _Widget ones like dojo/dnd/Source objects | ||||
| */ | ||||
| startup(): void; | ||||
| /** | ||||
| * Deprecated. Use set('href', ...) instead. | ||||
| */ | ||||
| setHref(href: string | URL): ContentPane; | ||||
| /** | ||||
| * Deprecated. Use set('content', ...) instead. | ||||
| */ | ||||
| setContent(data: ContentSetterContent): ContentPane; | ||||
| /** | ||||
| * Cancels an in-flight download of content | ||||
| */ | ||||
| cancel(): void; | ||||
| /** | ||||
| * [Re]download contents of href and display | ||||
| */ | ||||
| refresh(): Deferred<any>; | ||||
| /** | ||||
| * Destroy all the widgets inside the ContentPane and empty containerNode | ||||
| */ | ||||
| destroyDescendants(preserveDom?: boolean): void; | ||||
| /** | ||||
| * Event hook, is called after everything is loaded and widgetified | ||||
| */ | ||||
| onLoad(data?: any): void; | ||||
| /** | ||||
| * Event hook, is called before old content is cleared | ||||
| */ | ||||
| onUnload(): void; | ||||
| /** | ||||
| * Called before download starts. | ||||
| */ | ||||
| onDownloadStart(): string; | ||||
| /** | ||||
| * Called on DOM faults, require faults etc. in content. | ||||
| * In order to display an error message in the pane, return | ||||
| * the error message from this method, as an HTML string. | ||||
| * By default (if this method is not overriden), it returns | ||||
| * nothing, so the error message is just printed to the console. | ||||
| */ | ||||
| onContentError(error: Error): void; | ||||
| /** | ||||
| * Called when download error occurs. | ||||
| * In order to display an error message in the pane, return | ||||
| * the error message from this method, as an HTML string. | ||||
| * Default behavior (if this method is not overriden) is to display | ||||
| * the error message inside the pane. | ||||
| */ | ||||
| onDownloadError(error: Error): void; | ||||
| /** | ||||
| * Called when download is finished. | ||||
| */ | ||||
| onDownloadEnd(): void; | ||||
| } | ||||
| type ContentPaneConstructor = _WidgetBaseConstructor<ContentPane>; | ||||
| declare const ContentPane: ContentPaneConstructor; | ||||
| export = ContentPane; | ||||