Class JournalEntryPageSheet

An abstract Application responsible for displaying and editing a single JournalEntryPage Document.

Mixes

HandlebarsApplication

Hierarchy (View Summary)

Constructors

constructor

Properties

isV2 toc _appId _maxZ BASE_APPLICATION DEFAULT_OPTIONS emittedEvents isV2 RENDER_STATES TABS

Accessors

isView page

Methods

_insertElement _onRender _prepareContext _onCloseView _prepareHeadingLevels _migrateConstructorParams inheritanceChain parseCSSDimension waitForImages

Constructors

constructor

Properties

isV2

isV2: boolean = ...

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

toc

toc: Record<string, JournalEntryPageHeading>

The table of contents for this text page.

Static Internal_appId

_appId: number = 0

An incrementing integer Application ID.

Static Internal_maxZ

_maxZ: number = ...

The current maximum z-index of any displayed Application.

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

StaticDEFAULT_OPTIONS

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

StaticemittedEvents

emittedEvents: readonly [unknown, "closeView"] = ...

Inherit Doc

StaticisV2

isV2: boolean = true

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

StaticRENDER_STATES

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

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

StaticTABS

TABS: Record<string, ApplicationTabsConfiguration> = {}

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

Accessors

isView

  • get isView(): boolean

    Whether the sheet is in view mode.

    Returns boolean

page

Methods

_insertElement

  • _insertElement(element: any): void

    Parameters

    • element: any

    Returns void

    Inherit Doc

_onRender

  • _onRender(context: any, options: any): Promise<void>

    Parameters

    • context: any
    • options: any

    Returns Promise<void>

    Inherit Doc

_prepareContext

  • _prepareContext(options: any): Promise<any>

    Parameters

    • options: any

    Returns Promise<any>

    Inherit Doc

Protected_onCloseView

  • _onCloseView(): void
    Protected

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

    Returns void

Protected_prepareHeadingLevels

  • _prepareHeadingLevels(): Record<string, string>
    Protected

    Prepare heading level choices.

    Returns Record<string, string>

Static_migrateConstructorParams

StaticinheritanceChain

  • inheritanceChain(): Generator<typeof ApplicationV2, void, unknown>

    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>

    See

    ApplicationV2.BASE_APPLICATION

    Yields

StaticparseCSSDimension

  • parseCSSDimension(style: string, parentDimension: number): number | void

    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

StaticwaitForImages

  • waitForImages(element: HTMLElement): Promise<void>

    Wait for any images in the given element to load.

    Parameters

    • element: HTMLElement

      The element.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods