Class JournalEntryPageProseMirrorSheet

An Application responsible for displaying a single text-type JournalEntryPage Document, and editing it with a ProseMirror editor.

Hierarchy (View Summary)

JournalEntryPageTextSheet
- JournalEntryPageProseMirrorSheet

Constructors

constructor

new JournalEntryPageProseMirrorSheet(
options: any,
...args: any[],
): JournalEntryPageProseMirrorSheet
Parameters
- options: any
- ...args: any[]
Returns JournalEntryPageProseMirrorSheet
Inherit Doc
Inherited from JournalEntryPageTextSheet.constructor

Properties

isV2

isV2: boolean = ...

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

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

`Static`BASE_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.

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: { window: { icon: string } } = ...

`Static`EDIT_PARTS

EDIT_PARTS: {
    content: { template: string };
    footer: HandlebarsTemplatePart;
    header: HandlebarsTemplatePart;
} = ...

Inherit Doc

`Static`emittedEvents

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

Inherit Doc

`Static`format

format: number = JOURNAL_ENTRY_PAGE_FORMATS.HTML

The format used to edit text content in this sheet.

`Static`isV2

isV2: boolean = true

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

`Static`RENDER_STATES

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

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

`Static`TABS

TABS: Record<string, ApplicationTabsConfiguration> = {}

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

`Static`VIEW_PARTS

VIEW_PARTS: { content: { root: boolean; template: string } } = ...

`Protected` `Static`_converter

_converter: Converter = ...

Bi-directional HTML <-> Markdown converter.

Accessors

isView

get isView(): boolean
Whether the sheet is in view mode.

Returns boolean
Inherited from JournalEntryPageTextSheet.isView

Methods

_attachFrameListeners

_attachFrameListeners(): void
Returns void
Inherit Doc

_canRender

_canRender(options: any): boolean
Parameters
- options: any
Returns boolean

_configureRenderParts

_configureRenderParts(options: any): any
Parameters
- options: any
Returns any
Inherited from JournalEntryPageTextSheet._configureRenderParts

_insertElement

_insertElement(element: any): void
Parameters
- element: any
Returns void
Inherit Doc
Inherited from JournalEntryPageTextSheet._insertElement

_isEditorDirty

_isEditorDirty(): any
Returns any
Overrides JournalEntryPageTextSheet._isEditorDirty

_onAutosave

_onAutosave(content: string): void
Internal
Update the parent sheet if it is open when the server autosaves the contents of this editor.
Parameters
- content: string
  The updated editor contents.
Returns void

_onNewSteps

_onNewSteps(): void
Internal
Update the UI appropriately when receiving new steps from another client.

Returns void

_onRender

_onRender(context: any, options: any): Promise<void>
Parameters
- context: any
- options: any
Returns Promise<void>
Inherit Doc
Inherited from JournalEntryPageTextSheet._onRender

_prepareContentContext

_prepareContentContext(context: any, options: any): Promise<void>
Parameters
- context: any
- options: any
Returns Promise<void>
Inherit Doc
Overrides JournalEntryPageTextSheet._prepareContentContext

_prepareContext

_prepareContext(options: any): Promise<any>
Parameters
- options: any
Returns Promise<any>
Inherit Doc
Inherited from JournalEntryPageTextSheet._prepareContext

_preparePartContext

_preparePartContext(partId: any, context: any, options: any): Promise<any>
Parameters
- partId: any
- context: any
- options: any
Returns Promise<any>
Inherit Doc
Inherited from JournalEntryPageTextSheet._preparePartContext

_prepareSubmitData

_prepareSubmitData(event: any, form: any, formData: any, updateData: any): any
Parameters
- event: any
- form: any
- formData: any
- updateData: any
Returns any
Inherit Doc
Inherited from JournalEntryPageTextSheet._prepareSubmitData

`Protected`_onCloseView

_onCloseView(): void
Protected
Actions performed when this sheet is closed in some parent view.

Returns void
Inherited from JournalEntryPageTextSheet._onCloseView

`Protected`_onConfigurePlugins

_onConfigurePlugins(event: ProseMirrorPluginsEvent): void
Protected
Configure plugins for the ProseMirror instance.
Parameters
- event: ProseMirrorPluginsEvent
Returns void

`Protected`_prepareFooterContext

_prepareFooterContext(
context: ApplicationRenderContext,
options: HandlebarsRenderOptions,
): Promise<void>
Protected
Prepare render context for the footer part.
Parameters
- context: ApplicationRenderContext
- options: HandlebarsRenderOptions
Returns Promise<void>
Inherited from JournalEntryPageTextSheet._prepareFooterContext

`Protected`_prepareHeaderContext

_prepareHeaderContext(
context: ApplicationRenderContext,
options: HandlebarsRenderOptions,
): Promise<void>
Protected
Prepare render context for the header part.
Parameters
- context: ApplicationRenderContext
- options: HandlebarsRenderOptions
Returns Promise<void>
Inherited from JournalEntryPageTextSheet._prepareHeaderContext

`Protected`_prepareHeadingLevels

_prepareHeadingLevels(): Record<string, string>
Protected
Prepare heading level choices.

Returns Record<string, string>
Inherited from JournalEntryPageTextSheet._prepareHeadingLevels

`Static`_migrateConstructorParams

_migrateConstructorParams(
first: unknown,
rest: unknown[],
): Partial<ApplicationConfiguration & DocumentSheetConfiguration>
Internal
Provide a deprecation path for converted V1 document sheets.
Parameters
- first: unknown
  The first parameter received by this class's constructor
- rest: unknown[]
  Any additional parameters received
Returns Partial<ApplicationConfiguration & DocumentSheetConfiguration>
Inherited from JournalEntryPageTextSheet._migrateConstructorParams

`Static`inheritanceChain

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
Inherited from JournalEntryPageTextSheet.inheritanceChain

`Static`parseCSSDimension

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

Inherited from JournalEntryPageTextSheet.parseCSSDimension

`Static`waitForImages

waitForImages(element: HTMLElement): Promise<void>
Wait for any images in the given element to load.
Parameters
- element: HTMLElement
  The element.
Returns Promise<void>
Inherited from JournalEntryPageTextSheet.waitForImages

Class JournalEntryPageProseMirrorSheet

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns JournalEntryPageProseMirrorSheet

Inherit Doc

Properties

isV2

toc

Static Internal_appId

Static Internal_maxZ

StaticBASE_APPLICATION

StaticDEFAULT_OPTIONS

StaticEDIT_PARTS

Inherit Doc

StaticemittedEvents

Inherit Doc

Staticformat

StaticisV2

StaticRENDER_STATES

StaticTABS

StaticVIEW_PARTS

Protected Static_converter

Accessors

isView

Returns boolean

page

Returns documents.JournalEntryPage

Methods

_attachFrameListeners

Returns void

Inherit Doc

_canRender

Parameters

Returns boolean

_configureRenderParts

Parameters

Returns any

_insertElement

Parameters

Returns void

Inherit Doc

_isEditorDirty

Returns any

_onAutosave

Parameters

Returns void

_onNewSteps

Returns void

_onRender

Parameters

Returns Promise<void>

Inherit Doc

_prepareContentContext

Parameters

Returns Promise<void>

Inherit Doc

_prepareContext

Parameters

Returns Promise<any>

Inherit Doc

_preparePartContext

Parameters

Returns Promise<any>

Inherit Doc

_prepareSubmitData

Parameters

Returns any

Inherit Doc

Protected_onCloseView

Returns void

Protected_onConfigurePlugins

Parameters

Returns void

`Static` `Internal`_appId

`Static` `Internal`_maxZ

`Static`BASE_APPLICATION

`Static`DEFAULT_OPTIONS

`Static`EDIT_PARTS

`Static`emittedEvents

`Static`format

`Static`isV2

`Static`RENDER_STATES

`Static`TABS

`Static`VIEW_PARTS

`Protected` `Static`_converter

`Protected`_onCloseView

`Protected`_onConfigurePlugins

`Protected`_prepareFooterContext

`Protected`_prepareHeaderContext

`Protected`_prepareHeadingLevels

`Static`_migrateConstructorParams

`Static`inheritanceChain

`Static`parseCSSDimension

`Static`waitForImages