An abstract subclass that contains specialised handlebars logic for JournalEntryPageSheets.

HandlebarsApplication

Hierarchy (View Summary)

Constructors

Properties

isV2: boolean = ...

Indicates that the sheet renders with App V2 rather than V1.

toc: Record<string, JournalEntryPageHeading>

The table of contents for this text page.

_appId: number = 0

An incrementing integer Application ID.

_maxZ: number = ...

The current maximum z-index of any displayed Application.

BASE_APPLICATION: typeof ApplicationV2 = ApplicationV2

Designates which upstream Application class in this class' inheritance chain is the base application. Any DEFAULT_OPTIONS of super-classes further upstream of the BASE_APPLICATION are ignored. Hook events for super-classes further upstream of the BASE_APPLICATION are not dispatched.

DEFAULT_OPTIONS: {
    classes: string[];
    form: { submitOnChange: boolean };
    includeTOC: boolean;
    mode: string;
    position: { height: number; width: number };
    viewClasses: never[];
    viewPermission: 2;
    window: { resizable: boolean };
} = ...
EDIT_PARTS: Record<string, HandlebarsTemplatePart> = ...

Handlebars parts to render in edit mode.

emittedEvents: readonly [unknown, "closeView"] = ...
isV2: boolean = true

Indicates that the sheet renders with App V2 rather than V1.

RENDER_STATES: Record<string, number> = ...

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

TABS: Record<string, ApplicationTabsConfiguration> = {}

Configuration of application tabs, with an entry per tab group.

VIEW_PARTS: Record<string, HandlebarsTemplatePart> = {}

Handlebars part to render in view mode.

Accessors

  • get isView(): boolean

    Whether the sheet is in view mode.

    Returns boolean

Methods

  • Parameters

    • options: any

    Returns any

  • Parameters

    • element: any

    Returns void

  • Parameters

    • context: any
    • options: any

    Returns Promise<void>

  • Parameters

    • options: any

    Returns Promise<any>

  • Parameters

    • partId: any
    • context: any
    • options: any

    Returns Promise<any>

  • Parameters

    • event: any
    • form: any
    • formData: any
    • updateData: any

    Returns any

  • Protected

    Actions performed when this sheet is closed in some parent view.

    Returns void

  • Protected

    Prepare heading level choices.

    Returns Record<string, string>

  • Iterate over the inheritance chain of this Application. The chain includes this Application itself and all parents until the base application is encountered.

    Returns Generator<typeof ApplicationV2, void, unknown>

  • Parse a CSS style rule into a number of pixels which apply to that dimension.

    Parameters

    • style: string

      The CSS style rule

    • parentDimension: number

      The relevant dimension of the parent element

    Returns number | void

    The parsed style dimension in pixels

  • Wait for any images in the given element to load.

    Parameters

    • element: HTMLElement

      The element.

    Returns Promise<void>