Extends
Members
(static) defaultOptions
- Source:
_dragDrop :Array.<DragDrop>
- Source:
- Inherited From:
DragDrop workflow handlers which are active for this Application
Type:
_element :jQuery
- Source:
- Inherited From:
An internal reference to the HTML element this application renders
Type:
- jQuery
_scrollPositions :Object|null
- Source:
- Inherited From:
Track the most recent scroll positions for any vertically scrolling containers
Type:
- Object | null
_tabs :Array.<TabsV2>
- Source:
- Inherited From:
Tab navigation handlers which are active for this Application
Type:
appId :Number
- Source:
- Inherited From:
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
Type:
editors :Object
- Source:
- Inherited From:
Keep track of any mce editors which may be active as part of this form The values of this Array are inner-objects with references to the MCE editor and other metadata
Type:
- Object
element :jQuery|HTMLElement
- Source:
- Inherited From:
Return the active application element, if it currently exists in the DOM
Type:
- jQuery | HTMLElement
entity :Entity
- Source:
- Inherited From:
A convenience accessor for the object property, which in the case of a BaseEntitySheet is an Entity instance.
Type:
filepickers :Array
- Source:
- Inherited From:
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
- Source:
- Inherited From:
A convenience reference to the form HTMLElement
Type:
- HTMLElement
id
- Source:
- Overrides:
Return the CSS application ID which uniquely references this UI element
isEditable :boolean
- Source:
- Inherited From:
Is the Form Application currently editable?
Type:
- boolean
object :*
- Source:
- Inherited From:
The object target which we are using this form to modify
Type:
- *
options :Object
- Source:
- Inherited From:
The options provided to this application upon initialization
Type:
- Object
popOut :boolean
- Source:
- Inherited From:
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
- Source:
- Inherited From:
Track the current position and dimensions of the Application UI
Type:
- Object
rendered :boolean
- Source:
- Inherited From:
Return a flag for whether the Application instance is currently rendered
Type:
- boolean
template :string
- Source:
- Inherited From:
The path to the HTML template file which should be used to render the inner content of the app
Type:
- string
title :string
- Source:
- Inherited From:
An Application window should define its own title definition logic which may be dynamic depending on its data
Type:
- string
Methods
activateListeners(html)
- Source:
- Overrides:
Activate the default set of listeners for the Entity sheet These listeners handle basic stuff like form submission or updating images
Parameters:
| Name | Type | Description |
|---|---|---|
html |
JQuery | The rendered template ready to have listeners attached |
(async) close() → {Promise}
- Source:
- Inherited From:
Extend the logic applied when the application is closed to destroy any remaining MCE instances This function returns a Promise which resolves once the window closing animation concludes
Parameters:
| Name | Type | Description |
|---|---|---|
options.submit |
boolean | Explicitly specify whether or not to submit the form when closing. Default behavior uses the value of FormApplication.options.submitOnClose. |
Returns:
- Type
- Promise
(async) maximize() → {Promise}
- Source:
- Inherited From:
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 to true once the maximization action has completed
- Type
- Promise
(async) minimize() → {Promise}
- Source:
- Inherited From:
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 to true once the minimization action has completed
- Type
- Promise
render(force, options)
- Source:
- Inherited From:
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
|
setPosition(left, top, width, height, scale) → {Object}
- Source:
- Inherited From:
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(options) → {FormApplication}
- Source:
- Inherited From:
Submit the contents of a Form Application, processing its content as defined by the Application
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object | null | Options passed to the _onSubmit event handler |
Returns:
Return a self-reference for convenient method chaining
- Type
- FormApplication