Class JournalSheet

constructor

• new JournalSheet(object, options?): JournalSheet

• Parameters

  • object: Document

    A Document instance which should be managed by this form.
  • Optional options: ApplicationOptions = {}

    Optional configuration parameters for how the form behaves.

  Returns JournalSheet

object

form

editors

options

_element

position

_dragDrop

_tabs

_searchFilters

_minimized

_scrollPositions

appId

Static RENDER_STATES

document

• get document(): ClientDocument

• A semantic convenience reference to the Document instance which is the target object for this form.

  Returns ClientDocument

id

• get id(): string

• Return the CSS application ID which uniquely references this UI element

  Returns string

isEditable

• get isEditable(): any

• Is the Form Application currently editable?

  Returns any

element

• get element(): jQuery

• Return the active application element, if it currently exists in the DOM

  Returns jQuery

template

• get template(): string

• The path to the HTML template file which should be used to render the inner content of the app

  Returns string

popOut

• 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

rendered

• get rendered(): boolean

• Return a flag for whether the Application instance is currently rendered

  Returns boolean

closing

• get closing(): boolean

• Whether the Application is currently closing.

  Returns boolean

_activateCoreListeners

• _activateCoreListeners(html): void

• 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

activateEditor

• activateEditor(name, options?, initialContent?): Promise<any>

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

_renderOuter

• _renderOuter(): Promise<jQuery>

• Render the outer application wrapper

  Returns Promise<jQuery>

  A promise resolving to the constructed jQuery object

_renderInner

• _renderInner(...args): Promise<jQuery>

• 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

saveEditor

• saveEditor(name, options?): Promise<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

• submit(options?): Promise<FormApplication>

• 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

• render(force?, options?): Application

• 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

activateTab

• activateTab(tabName, options?): void

• 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

bringToTop

• bringToTop(): void

• Bring the application to the top of the rendering stack

  Returns void

minimize

• minimize(): Promise<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

• maximize(): Promise<void>

• 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

setPosition

• setPosition(position?): void | {
      left: number;
      top: number;
      width: number;
      height: number;
      scale: number;
  }

• 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;
  }