The object target which we are using this form to modify
A convenience reference to the form HTMLElement
Keep track of any mce editors which may be active as part of this form The values of this object are inner-objects with references to the MCE editor and other metadata
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.
Static RENDER_The sequence of rendering states that track the Application life-cycle.
Static Protected _customAn array of custom element tag names that should be listened to for changes.
Static Private #pendingAn array of pending sheet assignments which are submitted before other elements of the framework are ready.
An Application window should define its own title definition logic which may be dynamic depending on its data
Is the Form Application currently editable?
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 defaultAssign the default options which are supported by the document edit sheet. In addition to the default options object supported by the parent Application class, the Form Application supports the following additional keys and values:
The default options for this FormApplication class
An 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
This method is called upon form submission after form data is validated
The initial triggering submission event
The object of validated form data with which to update the object
A Promise which resolves once the update operation has completed
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
Activate a named TinyMCE text editor
The named data field which the editor modifies.
Editor initialization options passed to TextEditor.create.
Initial text content for the editor area.
Handle saving the content of a specific editor by name
The named editor to save
Optional options: { Remove the editor after saving its content
Prevent normal re-rendering of the sheet after saving.
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
Submit the contents of a Form Application, processing its content as defined by the Application
Optional options: any = {}Options passed to the _onSubmit event handler
Return a self-reference for convenient method chaining
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 _disableProtected _onProtected _getProtected _onProtected _onProtected _onProtected _activateProtected _configureProtected Configure ProseMirror plugins for this sheet.
The name of the editor.
Optional options: { Additional options to configure the plugins.
Whether the editor should destroy itself on save.
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 _renderProtected _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 _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 _waitStatic getMarshal information on the available sheet classes for a given document type and sub-type, and format it for display.
The Document type.
The Document sub-type.
Static initializeStatic registerRegister a sheet class as a candidate which can be used to display documents of a given type
The Document class for which to register a new Sheet option
Provide a unique namespace scope for this sheet
A defined Application class used to render the sheet
Optional config: { Additional options used for sheet registration
A human-readable label for the sheet name, which will be localized
An array of document types for which this sheet should be used
Whether to make this sheet the default for provided types
Whether this sheet is available to be selected as a default sheet for all Documents of that type.
Whether this sheet appears in the sheet configuration UI for users.
Static unregisterUnregister a sheet class, removing it from the list of available Applications to use for a Document type
The Document class for which to register a new Sheet option
Provide a unique namespace scope for this sheet
A defined DocumentSheet subclass used to render the sheet
Optional config: { An Array of types for which this sheet should be removed
Static updateStatic Private #registerPerform the sheet registration.
Configuration for how the sheet should be registered
The Document class being registered
The sheet ID being registered
The human-readable sheet label
The sheet class definition being registered
An array of types for which this sheet is added
Make this sheet the default for provided types?
Whether this sheet is available to be selected as a default sheet for all Documents of that type.
Whether the sheet appears in the sheet configuration UI for users.
Static Private #unregisterPerform the sheet de-registration.
Configuration for how the sheet should be un-registered
The Document class being unregistered
The sheet ID being unregistered
An array of types for which this sheet is removed
Static Private _register
Document Sheet Configuration Application