The options provided to this application upon initialization
An internal reference to the HTML element this application renders
Track the current position and dimensions of the Application UI
DragDrop workflow handlers which are active for this Application
Tab navigation handlers which are active for this Application
SearchFilter handlers which are active for this Application
Track whether the Application is currently minimized
Track the most recent scroll positions for any vertically scrolling containers
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
Protected _stateThe current render state of the Application
Protected _priorThe prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.
Private #onA bound instance of the _onKeyDown method which is used to listen to keypress events while the Dialog is active.
Static RENDER_The sequence of rendering states that track the Application life-cycle.
An Application window should define its own title definition logic which may be dynamic depending on its data
Return the CSS application ID which uniquely references this UI element
Return the active application element, if it currently exists in the DOM
The path to the HTML template file which should be used to render the inner content of the app
Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered
Return a flag for whether the Application instance is currently rendered
Whether the Application is currently closing.
Static defaultAn application should define the data object used to render its template. This function may either return an Object directly, or a Promise which resolves to an Object If undefined, the default implementation will return an empty object allowing only for rendering of static HTML
Close the application and un-register references to it within UI mappings This function returns a Promise which resolves once the window closing animation concludes
Options which affect how the Application is closed
A Promise which resolves once the application is closed
closeApplication
Render the Application by evaluating it's HTML template against the object of data provided by the getData method If the Application is rendered as a pop-out window, wrap the contained HTML in an outer frame with window controls
Add the rendered application to the DOM if it is not already present. If false, the Application will only be re-rendered if it is already present.
Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.
The left positioning attribute
The top positioning attribute
The rendered width
The rendered height
The rendered transformation scale
Apply focus to the application, maximizing it and bringing it to the top of the vertical stack.
A context-providing string which suggests what event triggered the render
The data change which motivated the render request
The rendered Application instance
Change the currently active tab
The target tab name to switch to
Options which configure changing the tab
A specific named tab group, useful if multiple sets of tabs are present
Whether to trigger tab-change callback functions
Set the application position and store its new location. Returns the updated position object for the application containing the new values.
Positional data
The left offset position in pixels
The top offset position in pixels
The application width in pixels
The application height in pixels
The application scale as a numeric factor where 1.0 is default
Protected _renderProtected An asynchronous inner function which handles the rendering of the Application
Render and display the application even if it is not currently displayed.
Additional options which update the current values of the Application#options object
A Promise that resolves to the Application once rendering is complete
renderApplication
Protected _callProtected Internal Call all hooks for all applications in the inheritance chain.
The hook being triggered, which formatted with the Application class name
Rest ...hookArgs: any[]The arguments passed to the hook calls
Protected _saveProtected _restoreProtected _getProtected Specify the set of config buttons which should appear in the Application header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.
getApplicationHeaderButtons
Protected _activateProtected _onProtected Handle changes to the active tab in a configured Tabs controller
A left click event
The Tabs controller
The new active tab name
Protected _onProtected Handle changes to search filtering controllers which are bound to the Application
The key-up event from keyboard input
The raw string input to the search field
The regular expression to test against
The HTML element which should be filtered
Protected _canProtected _canProtected _onProtected _onProtected _onProtected _waitPrivate _onPrivate _onPrivate submitStatic confirmA helper factory method to create simple confirmation dialog windows which consist of simple yes/no prompts. If you require more flexibility, a custom Dialog instance is preferred.
Confirmation dialog configuration
A promise which resolves once the user makes a choice or closes the window.
let d = Dialog.confirm({
title: "A Yes or No Question",
content: "<p>Choose wisely.</p>",
yes: () => console.log("You chose ... wisely"),
no: () => console.log("You chose ... poorly"),
defaultYes: false
});
Static promptA helper factory method to display a basic "prompt" style Dialog with a single button
Dialog configuration options
The returned value from the provided callback function, if any
Static waitWrap the Dialog with an enclosing Promise which resolves or rejects when the client makes a choice.
Optional data: DialogData = {}Data passed to the Dialog constructor.
Optional options: ApplicationOptions = {}Options passed to the Dialog constructor.
Optional renderOptions: object = {}Options passed to the Dialog render call.
A Promise that resolves to the chosen result.
Create a dialog window displaying a title, a message, and a set of buttons which trigger callback functions.
Param: data
An object of dialog data which configures how the modal window is rendered
Param: options
Dialog rendering options, see Application.
Example: Constructing a custom dialog instance