Class JournalEntrySheet

The Application responsible for displaying and editing a single JournalEntry Document.

Mixes

HandlebarsApplication

Hierarchy

any
- JournalEntrySheet

Index

Constructors

constructor

new JournalEntrySheet(options: any, ...args: any[]): JournalEntrySheet
Parameters
- options: any
- ...args: any[]
Returns JournalEntrySheet
Inherit Doc
Inherited from HandlebarsApplicationMixin(DocumentSheetV2).constructor

Properties

`Protected`_pages

_pages: Record<string, JournalSheetPageContext>

The cached list of processed page entries.

`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: {
    actions: {
        configCategories: (this: JournalEntrySheet) => void;
        createPage: () => any;
        editPage: (event: PointerEvent, target: HTMLElement) => any;
        goToHeading: (
            this: JournalEntrySheet,
            event: PointerEvent,
            target: HTMLElement,
        ) => void;
        nextPage: () => any;
        previousPage: () => any;
        showPlayers: () => void;
        toggleLock: (this: JournalEntrySheet) => void;
        toggleMode: (this: JournalEntrySheet) => any;
        toggleSearch: () => any;
        toggleSidebar: () => void;
    };
    classes: string[];
    form: { submitOnChange: boolean };
    position: { height: number; width: number };
    viewPermission: 0;
    window: { resizable: boolean };
} = ...

`Static`emittedEvents

emittedEvents: readonly ["prerender", "render", "close", "position"] = ...

`Static`OWNERSHIP_ICONS

OWNERSHIP_ICONS: { "0": string; "2": string; "3": string } = ...

Icons for page ownership.

`Static`PARTS

PARTS: {
pages: { scrollable: string[]; template: string };
sidebar: { scrollable: string[]; template: string; templates: string[] };
} = ...

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

VIEW_MODES: { MULTIPLE: number; SINGLE: number } = ...

The available view modes for journal entries.

Accessors

entry

get entry(): documents.JournalEntry
The JournalEntry for this sheet.

Returns documents.JournalEntry

isMultiple

get isMultiple(): boolean
Whether the sheet is in multi-page mode.

Returns boolean

locked

get locked(): boolean
Whether the journal is locked and disallows modifications to the table of contents.

Returns boolean

mode

get mode(): { MULTIPLE: number; SINGLE: number }
Get the JournalEntry's current view mode.

Returns { MULTIPLE: number; SINGLE: number }

observer

get observer(): IntersectionObserver
The currently active IntersectionObserver.

Returns IntersectionObserver

pageId

get pageId(): string
The ID of the currently-viewed page.

Returns string

pageIndex

get pageIndex(): number
The index of the currently-viewed page in the list of available pages.

Returns number

pagesInView

get pagesInView(): HTMLElement[]
The pages that are currently scrolled into view and marked as 'active' in the sidebar.

Returns HTMLElement[]

searchMode

get searchMode(): string
Get the JournalEntry's current search mode.

Returns string

sidebarExpanded

get sidebarExpanded(): boolean
The expanded state of the sidebar.

Returns boolean

title

get title(): string
Returns string

Methods

_attachFrameListeners

_attachFrameListeners(): void
Returns void
Inherit Doc

_configureRenderOptions

_configureRenderOptions(options: any): void
Parameters
- options: any
Returns void
Inherit Doc

_configureRenderParts

_configureRenderParts(options: any): any
Parameters
- options: any
Returns any
Inherit Doc

_getHeaderControls

_getHeaderControls(): any
Returns any
Inherit Doc

_initializeApplicationOptions

_initializeApplicationOptions(options: any): any
Parameters
- options: any
Returns any
Inherit Doc

_onClose

_onClose(options: any): void
Parameters
- options: any
Returns void
Inherit Doc

_onFirstRender

_onFirstRender(context: any, options: any): Promise<void>
Parameters
- context: any
- options: any
Returns Promise<void>
Inherit Doc

_onRender

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

_onRevealSecret

_onRevealSecret(event: any): void
Parameters
- event: any
Returns void

_prepareContext

_prepareContext(options: any): Promise<any>
Parameters
- options: any
Returns Promise<any>
Inherit Doc

_preparePartContext

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

_preSyncPartState

_preSyncPartState(
    partId: any,
    newElement: any,
    priorElement: any,
    state: any,
): void
Parameters
- partId: any
- newElement: any
- priorElement: any
- state: any
Returns void
Inherit Doc

_replaceHTML

_replaceHTML(result: any, content: any, options: any): void
Parameters
- result: any
- content: any
- options: any
Returns void
Inherit Doc

_tearDown

_tearDown(options: any): void
Parameters
- options: any
Returns void
Inherit Doc

_updateFrame

_updateFrame(options: any): void
Parameters
- options: any
Returns void
Inherit Doc

createPageDialog

createPageDialog(): any
Prompt the user with a Dialog for creation of a new JournalEntryPage.

Returns any

getPageSheet

getPageSheet(page: string | documents.JournalEntryPage): JournalPageSheet
Retrieve the sheet instance for rendering this page inline.
Parameters
- page: string | documents.JournalEntryPage
  The page instance or its ID.
Returns JournalPageSheet

goToPage

goToPage(pageId: string, options?: { anchor?: string }): any
Turn to a specific page.
Parameters
- pageId: string
  The ID of the page to turn to.
- Optionaloptions: { anchor?: string } = {}
  - Optionalanchor?: string
    Optionally an anchor slug to focus within that page.
Returns any

isPageVisible

isPageVisible(page: documents.JournalEntryPage): boolean
Determine whether a given page is visible to the current user.
Parameters
- page: documents.JournalEntryPage
  The page.
Returns boolean

nextPage(): any
Turn to the next page.

Returns any

previousPage(): any
Turn to the previous page.

Returns any

toggleSearchMode

toggleSearchMode(): any
Toggle the search mode for this journal entry between name and full text search.

Returns any

toggleSidebar

toggleSidebar(): void
Toggle the collapsed or expanded state of the sidebar.

Returns void

viewedPageDocuments

viewedPageDocuments(): Generator<any, void, unknown>
Iterate over the JournalEntryPage documents which are currently visible in the sheet.

Returns Generator<any, void, unknown>
Yields

`Protected`_activatePagesInView

_activatePagesInView(): void
Protected
Highlights the currently-viewed page in the sidebar.

Returns void

`Protected`_canDragDrop

_canDragDrop(selector: string): boolean
Protected
Determine if drop operations are permitted.
Parameters
- selector: string
  The candidate HTML selector for dragging
Returns boolean
Can the current user drag this selector?

`Protected`_canDragStart

_canDragStart(selector: string): boolean
Protected
Determine if drag operations are permitted.
Parameters
- selector: string
  The candidate HTML selector for dragging
Returns boolean
Can the current user drag this selector?

`Protected`_getEntryContextOptions

_getEntryContextOptions(): ContextMenuEntry[]
Protected
Get the set of ContextMenu options which should be used for journal entry pages in the sidebar.

Returns ContextMenuEntry[]

`Protected`_observeHeadings

_observeHeadings(): void
Protected
Create an intersection observer to maintain a list of headings that are in view. This is much more performant than calling getBoundingClientRect on all headings whenever we want to determine this list.

Returns void

`Protected`_observePages

_observePages(): void
Protected
Create an intersection observer to maintain a list of pages that are in view.

Returns void

`Protected`_onClickImage

_onClickImage(event: PointerEvent): void
Protected
Handle clicking an image to pop it out for fullscreen view.
Parameters
- event: PointerEvent
  The triggering click event.
Returns void

`Protected`_onContextMenuClose

_onContextMenuClose(target: HTMLElement): void
Protected
Handle closing the context menu.
Parameters
- target: HTMLElement
  The element the context menu has been triggered for.
Returns void

`Protected`_onContextMenuOpen

_onContextMenuOpen(target: HTMLElement): void
Protected
Handle opening the context menu.
Parameters
- target: HTMLElement
  The element the context menu has been triggered for.
Returns void

`Protected`_onDragStart

_onDragStart(event: DragEvent): void
Protected
Handle drag operations.
Parameters
- event: DragEvent
Returns void

`Protected`_onDrop

_onDrop(event: DragEvent): Promise<any>
Protected
Handle drop operations.
Parameters
- event: DragEvent
Returns Promise<any>

`Protected`_onEditPage

_onEditPage(event: PointerEvent, target: HTMLElement): any
Protected
Handle editing one of the journal entry's pages.
Parameters
- event: PointerEvent
  The triggering event.
- target: HTMLElement
  The action target.
Returns any

`Protected`_onPageScroll

_onPageScroll(
entries: IntersectionObserverEntry[],
observer: IntersectionObserver,
): void
Protected
Handle new pages scrolling into view.
Parameters
- entries: IntersectionObserverEntry[]
  An array of element that have scrolled into or out of view.
- observer: IntersectionObserver
  The IntersectionObserver that invoked this callback.
Returns void

`Protected`_onSearchFilter

_onSearchFilter(
    event: KeyboardEvent,
    query: string,
    rgx: RegExp,
    html: HTMLElement,
): void
Protected
Handle journal entry search and filtering.
Parameters
- event: KeyboardEvent
  The keyboard input event.
- query: string
  The input search string.
- rgx: RegExp
  The regular expression query that should be matched against.
- html: HTMLElement
  The container to filter items from.
Returns void

`Protected`_onShowPlayers

_onShowPlayers(): void
Protected
Handle a request to show the JournalEntry to other Users.

Returns void

`Protected`_preparePageData

_preparePageData(): Record<string, JournalSheetPageContext>
Protected
Prepare pages for display.

Returns Record<string, JournalSheetPageContext>

`Protected`_preparePagesContext

_preparePagesContext(
context: ApplicationRenderContext,
options: JournalSheetRenderOptions,
): Promise<void>
Protected
Prepare render context for the pages part.
Parameters
- context: ApplicationRenderContext
- options: JournalSheetRenderOptions
Returns Promise<void>

`Protected`_prepareSidebarContext

_prepareSidebarContext(
context: ApplicationRenderContext,
options: JournalSheetRenderOptions,
): Promise<void>
Protected
Prepare render context for the sidebar part.
Parameters
- context: ApplicationRenderContext
- options: JournalSheetRenderOptions
Returns Promise<void>

`Protected`_prepareTableOfContents

_prepareTableOfContents(): Promise<
(JournalSheetPageContext & JournalSheetCategoryContext)[],
>
Protected
Prepare the sidebar table of contents.

Returns Promise<(JournalSheetPageContext & JournalSheetCategoryContext)[]>

`Protected`_renderHeadings

_renderHeadings(
pageNode: HTMLElement,
toc: Record<string, JournalEntryPageHeading>,
): Promise<void>
Protected
Add headings to the table of contents for the given node.
Parameters
- pageNode: HTMLElement
  The HTML node of the page's rendered contents.
- toc: Record<string, JournalEntryPageHeading>
  The page's table of contents.
Returns Promise<void>

`Protected`_renderPageView

_renderPageView(
element: HTMLElement,
sheet: JournalEntryPageSheet,
): Promise<void>
Protected
Render the page view for a page sheet.
Parameters
- element: HTMLElement
  The existing page element in the journal entry view.
- sheet: JournalEntryPageSheet
  The page sheet.
Returns Promise<void>

`Protected`_renderPageViews

_renderPageViews(
context: ApplicationRenderContext,
options: JournalSheetRenderOptions,
): Promise<void>
Protected
Update child views inside the main sheet.
Parameters
- context: ApplicationRenderContext
- options: JournalSheetRenderOptions
Returns Promise<void>

`Protected`_setCurrentPage

_setCurrentPage(options?: JournalSheetRenderOptions): void
Protected
Update which page of the journal sheet should be currently rendered. This can be controlled by options passed into the render method, or by subclass override.
Parameters
- Optionaloptions: JournalSheetRenderOptions = {}
Returns void

`Protected`_synchronizeSidebar

_synchronizeSidebar(): void
Protected
If the set of active pages has changed, various elements in the sidebar will expand and collapse. For particularly long ToCs, this can leave the scroll position of the sidebar in a seemingly random state. We try to do our best to sync the sidebar scroll position with the current journal viewport.

Returns void

`Protected`_updateButtonState

_updateButtonState(): void
Protected
Update the disabled state of the previous and next page buttons.

Returns void

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

`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 HandlebarsApplicationMixin(DocumentSheetV2).inheritanceChain

`Static`instances

instances(): Generator<typeof ApplicationV2, any, any>
Iterate over the instances of this Application.

Returns Generator<typeof ApplicationV2, any, any>
Yields
Inherited from HandlebarsApplicationMixin(DocumentSheetV2).instances

`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 HandlebarsApplicationMixin(DocumentSheetV2).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 HandlebarsApplicationMixin(DocumentSheetV2).waitForImages

Class JournalEntrySheet

Mixes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns JournalEntrySheet

Inherit Doc

Properties

Protected_pages

Static Internal_appId

Static Internal_maxZ

StaticBASE_APPLICATION

StaticDEFAULT_OPTIONS

StaticemittedEvents

StaticOWNERSHIP_ICONS

StaticPARTS

StaticRENDER_STATES

StaticTABS

StaticVIEW_MODES

Accessors

entry

Returns documents.JournalEntry

isMultiple

Returns boolean

locked

Returns boolean

mode

Returns { MULTIPLE: number; SINGLE: number }

observer

Returns IntersectionObserver

pageId

Returns string

pageIndex

Returns number

pagesInView

Returns HTMLElement[]

searchMode

Returns string

sidebarExpanded

Returns boolean

title

Returns string

Methods

_attachFrameListeners

Returns void

Inherit Doc

_configureRenderOptions

Parameters

Returns void

Inherit Doc

_configureRenderParts

Parameters

Returns any

Inherit Doc

_getHeaderControls

Returns any

Inherit Doc

_initializeApplicationOptions

Parameters

Returns any

Inherit Doc

_onClose

Parameters

Returns void

Inherit Doc

_onFirstRender

Parameters

Returns Promise<void>

Inherit Doc

_onRender

Parameters

Returns Promise<void>

Inherit Doc

_onRevealSecret

`Protected`_pages

`Static` `Internal`_appId

`Static` `Internal`_maxZ

`Static`BASE_APPLICATION

`Static`DEFAULT_OPTIONS

`Static`emittedEvents

`Static`OWNERSHIP_ICONS

`Static`PARTS

`Static`RENDER_STATES

`Static`TABS

`Static`VIEW_MODES

`Optional`anchor?: string

`Protected`_activatePagesInView

`Protected`_canDragDrop

`Protected`_canDragStart

`Protected`_getEntryContextOptions

`Protected`_observeHeadings

`Protected`_observePages

`Protected`_onClickImage

`Protected`_onContextMenuClose

`Protected`_onContextMenuOpen