Extends
Members
(static) defaultOptions
Assign the default options which are supported by the entity 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:
_dragDrop :Array.<DragDrop>
- Overrides:
DragDrop workflow handlers which are active for this Application
Type:
_element :jQuery
- Overrides:
An internal reference to the HTML element this application renders
Type:
- jQuery
_minimized :boolean
- Overrides:
Track whether the Application is currently minimized
Type:
- boolean
(protected) _priorState :number
- Overrides:
- See:
-
- {Application.RENDER_STATES}
The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.
Type:
- number
_scrollPositions :Object|null
- Overrides:
Track the most recent scroll positions for any vertically scrolling containers
Type:
- Object | null
_searchFilters :Array.<SearchFilter>
- Overrides:
SearchFilter handlers which are active for this Application
Type:
(protected) _state :number
- Overrides:
- See:
-
- {Application.RENDER_STATES}
The current render state of the Application
Type:
- number
_tabs :Array.<Tabs>
- Overrides:
Tab navigation handlers which are active for this Application
Type:
appId :number
- Overrides:
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
Type:
- number
editors :Object.<string, object>
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
Type:
- Object.<string, object>
element :jQuery|HTMLElement
- Overrides:
Return the active application element, if it currently exists in the DOM
Type:
- jQuery | HTMLElement
filepickers :Array.<FilePicker>
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
Type:
form :HTMLElement
A convenience reference to the form HTMLElement
Type:
- HTMLElement
id :string
- Overrides:
Return the CSS application ID which uniquely references this UI element
Type:
- string
isEditable :boolean
Is the Form Application currently editable?
Type:
- boolean
object :*
The object target which we are using this form to modify
Type:
- *
options :Object
- Overrides:
The options provided to this application upon initialization
Type:
- Object
popOut :boolean
- Overrides:
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
Type:
- boolean
position :Object
- Overrides:
Track the current position and dimensions of the Application UI
Type:
- Object
RENDER_STATES :number
- Overrides:
The sequence of rendering states that track the Application life-cycle.
Type:
- number
rendered :boolean
- Overrides:
Return a flag for whether the Application instance is currently rendered
Type:
- boolean
template :string
- Overrides:
The path to the HTML template file which should be used to render the inner content of the app
Type:
- string
title :string
- Overrides:
An Application window should define its own title definition logic which may be dynamic depending on its data
Type:
- string
Methods
(protected) _activateCoreListeners(html)
- Overrides:
Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.
Parameters:
| Name | Type | Description |
|---|---|---|
html |
jQuery |
(protected) _activateEditor(div)
Activate a TinyMCE editor instance present within the form
Parameters:
| Name | Type | Description |
|---|---|---|
div |
HTMLElement | The element which contains the editor |
(protected) _activateFilePicker(event)
Activate a FilePicker instance present within the form
Parameters:
| Name | Type | Description |
|---|---|---|
event |
PointerEvent | The mouse click event on a file picker activation button |
(protected) _disableFields(form)
If the form is not editable, disable its input fields
Parameters:
| Name | Type | Description |
|---|---|---|
form |
HTMLElement | The form HTML |
(protected) _getFilePickerOptions(event) → {object}
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.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
PointerEvent | The initiating mouse click event which opens the picker |
Returns:
Options passed to the FilePicker constructor
- Type
- object
(protected) _getSubmitData(updateData) → {object}
Get an object of update data used to update the form's target object
Parameters:
| Name | Type | Description |
|---|---|---|
updateData |
object | Additional data that should be merged with the form data |
Returns:
The prepared update data
- Type
- object
(protected) _onChangeColorPicker()
Handle the change of a color picker input which enters it's chosen value into a related input field
(async, protected) _onChangeInput(event)
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.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | The initial change event |
(protected) _onChangeRange(event)
Handle changes to a range type input by propagating those changes to the sibling range-value element
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | The initial change event |
(protected) _onSelectFile(selection, filePicker)
Additional handling which should trigger when a FilePicker contained within this FormApplication is submitted.
Parameters:
| Name | Type | Description |
|---|---|---|
selection |
string | The target path which was selected |
filePicker |
FilePicker | The FilePicker instance which was submitted |
(async, protected) _onSubmit(event, updateDataopt, preventCloseopt, preventRenderopt) → {Promise}
Handle standard form submission steps
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
event |
Event | The submit event which triggered this handler |
|
updateData |
Object | null |
<optional> |
Additional specific data keys/values which override or extend the contents of the parsed form. This can be used to update other flags or data fields at the same time as processing a form submission to avoid multiple database operations. |
preventClose |
boolean |
<optional> |
Override the standard behavior of whether to close the form on submit |
preventRender |
boolean |
<optional> |
Prevent the application from re-rendering as a result of form submission |
Returns:
A promise which resolves to the validated update data
- Type
- Promise
(async, protected) _render(force, options) → {Promise.<void>}
- Overrides:
An asynchronous inner function which handles the rendering of the Application
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
force |
boolean |
false
|
Render and display the application even if it is not currently displayed. |
options |
Object | New Application options which update the current values of the Application#options object |
Returns:
A Promise that resolves to the Application once rendering is complete
- Type
- Promise.<void>
(async, abstract) _updateObject(event, formData) → {Promise}
This method is called upon form submission after form data is validated
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | The initial triggering submission event |
formData |
object | The object of validated form data with which to update the object |
Returns:
A Promise which resolves once the update operation has completed
- Type
- Promise
activateEditor(name, options, initialContent)
Activate a named TinyMCE text editor
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The named data field which the editor modifies. |
options |
object | TinyMCE initialization options passed to TextEditor.create |
initialContent |
string | Initial text content for the editor area. |
activateListeners(html)
- Overrides:
After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.
Parameters:
| Name | Type | Description |
|---|---|---|
html |
jQuery |
bringToTop()
- Overrides:
Bring the application to the top of the rendering stack
(async) close() → {Promise.<void>}
- Overrides:
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
Returns:
A Promise which resolves once the application is closed
- Type
- Promise.<void>
getData() → {Object|Promise}
- Overrides:
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
Returns:
- Type
- Object | Promise
(async) maximize() → {Promise.<void>}
- Overrides:
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
Returns:
A Promise which resolves once the maximization action has completed
- Type
- Promise.<void>
(async) minimize() → {Promise.<void>}
- Overrides:
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
Returns:
A Promise which resolves once the minimization action has completed
- Type
- Promise.<void>
render(force, options) → {Application}
- Overrides:
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
Parameters:
| Name | Type | Default | Description | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
force |
boolean |
false
|
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. |
|||||||||||||||||||||||||||||||||||||||||||||
options |
Object | Additional rendering options which are applied to customize the way that the Application is rendered in the DOM. Properties
|
Returns:
The rendered Application instance
- Type
- Application
(async) saveEditor(name, removeopt) → {Promise.<void>}
Handle saving the content of a specific editor by name
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | The named editor to save |
|
remove |
boolean |
<optional> |
Remove the editor after saving its content |
Returns:
- Type
- Promise.<void>
setPosition(left, top, width, height, scale) → {Object}
- Overrides:
Set the application position and store it's new location.
Parameters:
| Name | Type | Description |
|---|---|---|
left |
number | null | The left offset position in pixels |
top |
number | null | The top offset position in pixels |
width |
number | null | The application width in pixels |
height |
number | string | null | The application height in pixels |
scale |
number | null | The application scale as a numeric factor where 1.0 is default |
Returns:
The updated position object for the application containing the new values
- Type
- Object
(async) submit(optionsopt) → {FormApplication}
Submit the contents of a Form Application, processing its content as defined by the Application
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
object |
<optional> |
Options passed to the _onSubmit event handler |
Returns:
Return a self-reference for convenient method chaining
- Type
- FormApplication