The Application responsible for configuring a single Folder document.

Param: object

The Folder object to configure.

Param: options

Application configuration options.

Hierarchy (view full)

Constructors

Properties

object: any

The object target which we are using this form to modify

form: HTMLElement

A convenience reference to the form HTMLElement

editors: Record<string, any>

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

options: any

The options provided to this application upon initialization

_element: jQuery

An internal reference to the HTML element this application renders

position: any

Track the current position and dimensions of the Application UI

_dragDrop: DragDrop[]

DragDrop workflow handlers which are active for this Application

_tabs: Tabs[]

Tab navigation handlers which are active for this Application

_searchFilters: SearchFilter[]

SearchFilter handlers which are active for this Application

_minimized: boolean

Track whether the Application is currently minimized

_scrollPositions: any

Track the most recent scroll positions for any vertically scrolling containers

appId: number

The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT

_secrets: HTMLSecret[]

The list of handlers for secret block functionality.

_state: number

The current render state of the Application

See

_priorState: number

The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.

See

RENDER_STATES: Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}> = ...

The sequence of rendering states that track the Application life-cycle.

Type declaration

  • ERROR: -3
  • CLOSING: -2
  • CLOSED: -1
  • NONE: 0
  • RENDERING: 1
  • RENDERED: 2
_customElements: string[] = ...

An array of custom element tag names that should be listened to for changes.

Accessors

  • get id(): string
  • Returns string

  • get title(): string
  • Returns string

  • get document(): ClientDocument
  • A semantic convenience reference to the Document instance which is the target object for this form.

    Returns ClientDocument

  • get isEditable(): any
  • Is the Form Application currently editable?

    Returns any

  • get element(): jQuery
  • Return the active application element, if it currently exists in the DOM

    Returns jQuery

  • get template(): string
  • The path to the HTML template file which should be used to render the inner content of the app

    Returns string

  • get popOut(): boolean
  • 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

    Returns boolean

  • get rendered(): boolean
  • Return a flag for whether the Application instance is currently rendered

    Returns boolean

  • get closing(): boolean
  • Whether the Application is currently closing.

    Returns boolean

  • get defaultOptions(): any
  • Returns any

Methods

  • 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

    Parameters

    • options: {} = {}

      Options which affect how the Application is closed

      Returns Promise<void>

      A Promise which resolves once the application is closed

      Fires

      closeApplication

    • Parameters

      • options: {} = {}

        Returns Promise<{
            folder: any;
            name: any;
            newName: any;
            safeColor: any;
            sortingModes: {
                a: string;
                m: string;
            };
            submitText: string;
        }>

      • Parameters

        • event: any
        • formData: any

        Returns Promise<any>

      • Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.

        Parameters

        • html: any

        Returns void

      • Activate a named TinyMCE text editor

        Parameters

        • name: any

          The named data field which the editor modifies.

        • options: {} = {}

          Editor initialization options passed to TextEditor.create.

          • initialContent: string = ""

            Initial text content for the editor area.

          Returns Promise<any>

        • An asynchronous inner function which handles the rendering of the Application

          Parameters

          • force: any

            Render and display the application even if it is not currently displayed.

          • options: {} = {}

            Additional options which update the current values of the Application#options object

            Returns Promise<void>

            A Promise that resolves to the Application once rendering is complete

            Fires

            renderApplication

          • Render the outer application wrapper

            Returns Promise<jQuery>

            A promise resolving to the constructed jQuery object

          • 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.

            Returns ApplicationHeaderButton[]

            Fires

            getApplicationHeaderButtons

          • Render the inner application content

            Parameters

            • Rest ...args: any[]

              The data used to render the inner template

            Returns Promise<jQuery>

            A promise resolving to the constructed jQuery object

          • 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

            • html: any

            Returns void

          • Handle saving the content of a specific editor by name

            Parameters

            • name: string

              The named editor to save

            • Optional options: {
                  remove: boolean;
                  preventRender: boolean;
              } = {}
              • remove: boolean

                Remove the editor after saving its content

              • preventRender: boolean

                Prevent normal re-rendering of the sheet after saving.

            Returns Promise<void>

          • Submit the contents of a Form Application, processing its content as defined by the Application

            Parameters

            • Optional options: any = {}

              Options passed to the _onSubmit event handler

            Returns Promise<FormApplication>

            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

            Parameters

            • 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: {
                  left: number;
                  top: number;
                  width: number;
                  height: number;
                  scale: number;
                  focus: boolean;
                  renderContext: string;
                  renderData: any;
              } = {}

              Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.

              • left: number

                The left positioning attribute

              • top: number

                The top positioning attribute

              • width: number

                The rendered width

              • height: number

                The rendered height

              • scale: number

                The rendered transformation scale

              • focus: boolean

                Apply focus to the application, maximizing it and bringing it to the top of the vertical stack.

              • renderContext: string

                A context-providing string which suggests what event triggered the render

              • renderData: any

                The data change which motivated the render request

            Returns Application

            The rendered Application instance

          • Change the currently active tab

            Parameters

            • tabName: string

              The target tab name to switch to

            • options: {
                  group: string;
                  triggerCallback: boolean;
              } = {}

              Options which configure changing the tab

              • group: string

                A specific named tab group, useful if multiple sets of tabs are present

              • triggerCallback: boolean

                Whether to trigger tab-change callback functions

            Returns void

          • Bring the application to the top of the rendering stack

            Returns void

          • 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 Promise<void>

            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

            Returns Promise<void>

            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.

            Parameters

            • position: {
                  left: number;
                  top: number;
                  width: number;
                  height: string | number;
                  scale: number;
              } = {}

              Positional data

              • left: number

                The left offset position in pixels

              • top: number

                The top offset position in pixels

              • width: number

                The application width in pixels

              • height: string | number

                The application height in pixels

              • scale: number

                The application scale as a numeric factor where 1.0 is default

            Returns void | {
                left: number;
                top: number;
                width: number;
                height: number;
                scale: number;
            }

          • Protected

            Create an ID link button in the document sheet header which displays the document ID and copies to clipboard

            Parameters

            • html: jQuery

            Returns void

          • Protected

            Test whether a certain User has permission to view this Document Sheet.

            Parameters

            • user: User

              The user requesting to render the sheet

            Returns boolean

            Does the User have permission to view this sheet?

          • Protected

            Get the HTML content that a given secret block is embedded in.

            Parameters

            • secret: HTMLElement

              The secret block.

            Returns string

          • Protected

            Update the HTML content that a given secret block is embedded in.

            Parameters

            • secret: HTMLElement

              The secret block.

            • content: string

              The new content.

            Returns Promise<ClientDocument>

            The updated Document.

          • Protected

            Handle changing a Document's image.

            Parameters

            • event: MouseEvent

              The click event.

            Returns Promise<any>

          • Protected

            If the form is not editable, disable its input fields

            Parameters

            • form: HTMLElement

              The form HTML

            Returns void

          • Protected

            Handle standard form submission steps

            Parameters

            • event: Event

              The submit event which triggered this handler

            • Optional __namedParameters: any = {}

            Returns Promise<any>

            A promise which resolves to the validated update data

          • Protected

            Get an object of update data used to update the form's target object

            Parameters

            • updateData: any = {}

              Additional data that should be merged with the form data

            Returns any

            The prepared update data

          • Protected

            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

            • event: Event

              The initial change event

            Returns Promise<any>

          • Protected

            Handle the change of a color picker input which enters it's chosen value into a related input field

            Parameters

            • event: Event

              The color picker change event

            Returns void

          • Protected

            Handle changes to a range type input by propagating those changes to the sibling range-value element

            Parameters

            • event: Event

              The initial change event

            Returns void

          • Protected

            Activate an editor instance present within the form

            Parameters

            • div: HTMLElement

              The element which contains the editor

            Returns void

          • Protected

            Configure ProseMirror plugins for this sheet.

            Parameters

            • name: string

              The name of the editor.

            • Optional options: {
                  remove: boolean;
              } = {}

              Additional options to configure the plugins.

              • remove: boolean

                Whether the editor should destroy itself on save.

            Returns any

          • Protected Internal

            Call all hooks for all applications in the inheritance chain.

            Parameters

            • hookName: string | ((className) => string)

              The hook being triggered, which formatted with the Application class name

            • Rest ...hookArgs: any[]

              The arguments passed to the hook calls

            Returns void

          • Protected

            Persist the scroll positions of containers within the app before re-rendering the content

            Parameters

            • html: jQuery

              The HTML object being traversed

            Returns void

          • Protected

            Restore the scroll positions of containers within the app after re-rendering the content

            Parameters

            • html: jQuery

              The HTML object being traversed

            Returns void

          • Protected

            Handle changes to the active tab in a configured Tabs controller

            Parameters

            • event: MouseEvent

              A left click event

            • tabs: Tabs

              The Tabs controller

            • active: string

              The new active tab name

            Returns void

          • Protected

            Handle changes to search filtering controllers which are bound to the Application

            Parameters

            • event: KeyboardEvent

              The key-up event from keyboard input

            • query: string

              The raw string input to the search field

            • rgx: RegExp

              The regular expression to test against

            • html: HTMLElement

              The HTML element which should be filtered

            Returns void

          • Protected

            Define whether a user is able to begin a dragstart workflow for a given drag selector

            Parameters

            • selector: string

              The candidate HTML selector for dragging

            Returns boolean

            Can the current user drag this selector?

          • Protected

            Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector

            Parameters

            • selector: string

              The candidate HTML selector for the drop target

            Returns boolean

            Can the current user drop on this selector?

          • Protected

            Callback actions which occur at the beginning of a drag start workflow.

            Parameters

            • event: DragEvent

              The originating DragEvent

            Returns void

          • Protected

            Callback actions which occur when a dragged element is over a drop target.

            Parameters

            • event: DragEvent

              The originating DragEvent

            Returns void

          • Protected

            Callback actions which occur when a dragged element is dropped on a target.

            Parameters

            • event: DragEvent

              The originating DragEvent

            Returns void

          • Protected

            Wait for any images present in the Application to load.

            Returns Promise<void>

            A Promise that resolves when all images have loaded.