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
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
Render the inner application content
The data used to render the inner template
A promise resolving to the constructed jQuery object
Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.
After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.
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
Remove the editor after saving its content
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
A Promise which resolves once the application is closed
Submit the contents of a Form Application, processing its content as defined by the Application
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 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
Bring the application to the top of the rendering stack
Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized
A Promise which resolves once the minimization action has completed
Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized
A Promise which resolves once the maximization action has completed
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
|void}
If the form is not editable, disable its input fields
The form HTML
Handle standard form submission steps
The submit event which triggered this handler
A promise which resolves to the validated update data
Get an object of update data used to update the form's target object
Additional data that should be merged with the form data
The prepared update data
Handle changes to an input element, submitting the form if options.submitOnChange is true. Do not preventDefault in this handler as other interactions on the form may also be occurring.
The initial change event
Handle the change of a color picker input which enters it's chosen value into a related input field
The color picker change event
Handle changes to a range type input by propagating those changes to the sibling range-value element
The initial change event
Additional handling which should trigger when a FilePicker contained within this FormApplication is submitted.
The target path which was selected
The FilePicker instance which was submitted
Activate an editor instance present within the form
The element which contains the editor
Configure ProseMirror plugins for this sheet.
The name of the editor.
Additional options to configure the plugins.
Activate a FilePicker instance present within the form
The mouse click event on a file picker activation button
Determine the configuration options used to initialize a FilePicker instance within this FormApplication. Subclasses can extend this method to customize the behavior of pickers within their form.
The initiating mouse click event which opens the picker
Options passed to the FilePicker constructor
Persist the scroll positions of containers within the app before re-rendering the content
The HTML object being traversed
Restore the scroll positions of containers within the app after re-rendering the content
The HTML object being traversed
Render the outer application wrapper
A promise resolving to the constructed jQuery object
Handle changes to the active tab in a configured Tabs controller
A left click event
The Tabs controller
The new active tab name
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
Define whether a user is able to begin a dragstart workflow for a given drag selector
The candidate HTML selector for dragging
Can the current user drag this selector?
Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector
The candidate HTML selector for the drop target
Can the current user drop on this selector?
Callback actions which occur at the beginning of a drag start workflow.
The originating DragEvent
Callback actions which occur when a dragged element is over a drop target.
The originating DragEvent
Callback actions which occur when a dragged element is dropped on a target.
The originating DragEvent
Initialize the configured Sheet preferences for Documents which support dynamic Sheet assignment Create the configuration structure for supported documents Process any pending sheet registrations Update the default values from settings data
Register 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
Additional options used for sheet registration
Unregister 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
An Array of types for which this sheet should be removed
Update the current default Sheets using a new core world setting.
Perform the sheet registration.
Configuration for how the sheet should be un-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?
Perform 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
Initialize default sheet configurations for all document types.
The object target which we are using this form to modify
A convenience reference to the form HTMLElement
Keep track of any FilePicker instances which are associated with this form The values of this Array are inner-objects with references to the FilePicker instances and other metadata
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 current render state of the Application
The options provided to this application upon initialization
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
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 prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.
The sequence of rendering states that track the Application life-cycle.
An array of pending sheet assignments which are submitted before other elements of the framework are ready.
Document Sheet Configuration Application