Application instance configuration options.
The current position of the application with respect to the window.document.body.
If this Application uses tabbed navigation groups, this mapping is updated whenever the changeTab method is called.
Reports the active tab for each group, with a value of null indicating no tab is active.
Subclasses may override this property to define default tabs for each group.
Protected_The cached list of processed page entries.
Static Internal_An incrementing integer Application ID.
Static Internal_The current maximum z-index of any displayed Application.
StaticBASE_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_StaticemittedStaticOWNERSHIP_Icons for page ownership.
StaticPARTSStaticRENDER_The sequence of rendering states that describe the Application life-cycle.
StaticTABSConfiguration of application tabs, with an entry per tab group.
StaticVIEW_The available view modes for journal entries.
The child Applications registered under this one via renderChild.
The CSS class list of this Application instance
The Document instance associated with the application
The HTMLElement which renders this Application into the DOM.
The JournalEntry for this sheet.
Does this Application have a top-level form element?
Does this Application instance render within an outer window frame?
The HTML element ID of this Application instance.
This provides a readonly view into the internal ID used by this application.
This getter should not be overridden by subclasses, which should instead configure the ID in DEFAULT_OPTIONS or
by defining a uniqueId during _initializeApplicationOptions.
Is this Document sheet editable by the current User? This is governed by the editPermission threshold configured for the class.
Whether the sheet is in multi-page mode.
Is this Document sheet visible to the current User? This is governed by the viewPermission threshold configured for the class.
Whether the journal is locked and disallows modifications to the table of contents.
Is this Application instance currently minimized?
Get the JournalEntry's current view mode.
The currently active IntersectionObserver.
The ID of the currently-viewed page.
The index of the currently-viewed page in the list of available pages.
The pages that are currently scrolled into view and marked as 'active' in the sidebar.
The parent Application of this Application, if registered via renderChild.
Is this Application instance currently rendered?
Get the JournalEntry's current search mode.
The expanded state of the sidebar.
The current render state of the Application.
Convenience references to window header elements.
InternalWait for a CSS transition to complete for an element.
The element which is transitioning
A timeout in milliseconds in case the transitionend event does not occur
Whether this Application is permitted to detach from the main workspace. Managed children (those with an active parent) may detach to break the parent link and claim their own window.
InternalPerform an event in the application life-cycle. Await an internal life-cycle method defined by the class. Optionally dispatch an event for any registered listeners.
A handler function to call
Options which configure event handling
Optionalasync?: booleanAwait the result of the handler function?
OptionaldebugText?: stringDebugging text to log for the event
OptionaleventName?: stringAn event name to dispatch for registered listeners
OptionalhandlerArgs?: any[]Arguments passed to the handler function
OptionalhookArgs?: any[]Arguments passed to the requested hook function
OptionalhookName?: stringA hook name to dispatch for this and all parent classes
OptionalhookResponse?: booleanAdd the handler response to hookArgs
OptionalparentClassHooks?: booleanCall hooks for parent classes in the inheritance chain?
A promise which resoles once the handler is complete if async is true
Abstract_Render an HTMLElement for the Application. An Application subclass must implement this method in order for the Application to be renderable.
Context data for the render operation
Options which configure application rendering behavior
The result of HTML rendering may be implementation specific. Whatever value is returned here is passed to _replaceHTML
Add a new event listener for a certain type of event.
The type of event being registered for
The listener function called when the event occurs
Optionaloptions: { once?: boolean } = {}Options which configure the event listener
Optionalonce?: booleanShould the event only be responded to once and then removed
Re-attach a detached application to the main workspace. If this application was previously a child and was manually detached, breaking its parent link, this method first attempts to re-join the prior parent's window before falling back to the main workspace.
Optionaloptions: any = {}Render options.
Bring this Application window to the front of the rendering stack by increasing its z-index. Once ApplicationV1 is deprecated we should switch from _maxZ to ApplicationV2#maxZ We should also eliminate ui.activeWindow in favor of only ApplicationV2#frontApp
Change the active tab within a tab group in this Application instance.
The name of the tab which should become active
The name of the tab group which defines the set of tabs
Optionaloptions: {Additional options which affect tab navigation
Optionalevent?: EventAn interaction event which caused the tab change, if any
Optionalforce?: booleanForce changing the tab even if the new tab is already active
OptionalnavElement?: HTMLElementAn explicit navigation element being modified
OptionalupdatePosition?: booleanUpdate application position after changing the tab?
Close the Application, removing it from the DOM.
Optionaloptions: Partial<ApplicationClosingOptions> = {}Options which modify how the application is closed.
A Promise which resolves to the closed Application instance
Prompt the user with a Dialog for creation of a new JournalEntryPage.
Detach an application from the main workspace, and render it in a separate browser window. If this application is a registered child, detaching it breaks the parent link and gives it its own window.
Optionaloptions: any = {}Render options.
Dispatch an event on this target.
The Event to dispatch
Was default behavior for the event prevented?
Retrieve the sheet instance for rendering this page inline.
The page instance or its ID.
Turn to a specific page.
The ID of the page to turn to.
Optionaloptions: { anchor?: string } = {}Optionalanchor?: stringOptionally an anchor slug to focus within that page.
Determine whether a given page is visible to the current user.
The page.
Restore the Application to its original dimensions.
Minimize the Application, collapsing it to a minimal header.
Turn to the next page.
Turn to the previous page.
Remove an event listener for a certain type of event.
The type of event being removed
The listener function being removed
Render the Application, creating its HTMLElement and replacing its innerHTML. Add it to the DOM if it is not currently rendered and rendering is forced. Otherwise, re-render its contents.
Optionaloptions: any = {}Options which configure application rendering behavior. A boolean is interpreted as the "force" option.
Optional_options: any = {}Legacy options for backwards-compatibility with the original ApplicationV1#render signature.
A Promise which resolves to the rendered Application instance
Render another Application as a child of this one. The child is rendered in the same window as this application and moves with it when it is detached or re-attached. Closing this application will also close the child. If the child was previously registered under a different parent, that link is replaced.
The child application to render.
Optionaloptions: Partial<ApplicationRenderOptions> = {}Render options passed to the child's render method.
A Promise which resolves to the rendered child Application.
Update the Application element position using provided data which is merged with the prior position.
Optionalposition: Partial<ApplicationPosition>New Application positioning data
The updated application position
Programmatically submit an ApplicationV2 instance which implements a single top-level form.
OptionalsubmitOptions: object = {}Arbitrary options which are supported by and provided to the configured form submission handler.
A promise that resolves to the returned result of the form submission handler, if any.
Toggle the search mode for this journal entry between name and full text search.
Toggle the collapsed or expanded state of the sidebar.
Protected_ProtectedHighlights the currently-viewed page in the sidebar.
Protected_ProtectedWhether this Application is permitted to re-attach to the main workspace. Managed children (those with an active parent) cannot re-attach independently; their parent controls placement.
Protected_ProtectedDetermine if drop operations are permitted.
The candidate HTML selector for dragging
Can the current user drag this selector?
Protected_ProtectedDetermine if drag operations are permitted.
The candidate HTML selector for dragging
Can the current user drag this selector?
Protected_ProtectedCreate a ContextMenu instance used in this Application.
A handler function that provides initial context options
A CSS selector to which the ContextMenu will be bound
Optionaloptions: { container?: HTMLElement; hookName?: string; parentClassHooks?: boolean } = {}Additional options which affect ContextMenu construction
Optionalcontainer?: HTMLElementA parent HTMLElement which contains the selector target
OptionalhookName?: stringThe hook name
OptionalparentClassHooks?: booleanWhether to call hooks for the parent classes in the inheritance chain.
A created ContextMenu or null if no menu items were defined
Protected_ProtectedGet the set of ContextMenu options which should be used for journal entry pages in the sidebar.
Protected_ProtectedGet the configuration for a tabs group.
The ID of a tabs group
Protected_ProtectedGenerate context menu entries based on the header control specification.
Protected_ProtectedInsert the application HTML element into the DOM. Subclasses may override this method to customize how the application is inserted.
The element to insert
Optionaloptions: any = {}Render options.
Protected_ProtectedCreate 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.
Protected_ProtectedCreate an intersection observer to maintain a list of pages that are in view.
Protected_ProtectedActions performed after the Application has been re-attached to the main workspace. Registered child Applications are re-attached automatically after this method returns.
The Application's former host document. This document's window may have been closed.
The main workspace document.
Protected_ProtectedA generic event handler for action clicks which can be extended by subclasses. Action handlers defined in DEFAULT_OPTIONS are called first. This method is only called for actions which have no defined handler.
The originating click event
The capturing HTML element which defined a [data-action]
Protected_ProtectedHandle clicking an image to pop it out for fullscreen view.
The triggering click event.
Protected_ProtectedHandle click events on a tab within the Application.
Protected_ProtectedHandle closing the context menu.
The element the context menu has been triggered for.
Protected_ProtectedHandle opening the context menu.
The element the context menu has been triggered for.
Protected_ProtectedActions performed after the Application has been detached from the main workspace. Registered child Applications are moved into the same detached window automatically after this method returns.
The main workspace document.
The Application's new host document.
Protected_ProtectedHandle drag operations.
Protected_ProtectedHandle drop operations.
Protected_ProtectedHandle editing one of the journal entry's pages.
The triggering event.
The action target.
Protected_ProtectedHandle new pages scrolling into view.
An array of element that have scrolled into or out of view.
The IntersectionObserver that invoked this callback.
Protected_ProtectedActions performed after the Application is re-positioned.
The requested application position
Protected_ProtectedHandle journal entry search and filtering.
The keyboard input event.
The input search string.
The regular expression query that should be matched against.
The container to filter items from.
Protected_ProtectedHandle a request to show the JournalEntry to other Users.
Protected_ProtectedHandle submission for an Application which uses the form element.
The form configuration for which this handler is bound
The form submission event
Protected_ProtectedPerform post-render finalization actions.
Prepared context data.
Provided render options.
Protected_ProtectedActions performed before closing the Application. Pre-close steps are awaited by the close process.
Provided render options
Protected_ProtectedActions performed before a first render of the Application.
Prepared context data
Provided render options
Protected_Protected_ProtectedPrepare render context for the pages part.
Protected_ProtectedPrepare render context for the sidebar part.
Protected_ProtectedPrepare data used to update the Document upon form submission. This data is cleaned and validated before being returned for further processing.
The originating form submission event
The form element that was submitted
Processed data for the submitted form
OptionalupdateData: objectAdditional data passed in if this form is submitted manually which should be merged with prepared formData.
Prepared submission data as an object
Protected_ProtectedPrepare the sidebar table of contents.
Protected_ProtectedPrepare application tab data for a single tab group.
The ID of the tab group to prepare
Protected_ProtectedActions performed before the Application is re-positioned. Pre-position steps are not awaited because setPosition is synchronous.
The requested application position
Protected_ProtectedActions performed before any render of the Application. Pre-render steps are awaited by the render process.
Prepared context data
Provided render options
Protected_ProtectedCustomize how form data is extracted into an expanded object.
The originating form submission event
The form element that was submitted
Processed data for the submitted form
An expanded object of processed form data
Protected_ProtectedSubmit a document update or creation request based on the processed form data.
The originating form submission event
The form element that was submitted
Processed and validated form data to be used for a document update
Optionaloptions: Partial<DatabaseUpdateOperation | DatabaseCreateOperation> = {}Additional options altering the request
The result of the form submission that communicates whether a Document was created or updated. It is possible that neither creation nor update occurred.
Protected_ProtectedRe-fit an application to its content following a change in its natural size.
OptionalpositionUpdate: Partial<ApplicationPosition> = {}Position data forwarded to setPosition.
Protected_ProtectedRemove the application HTML element from the DOM. Subclasses may override this method to customize how the application element is removed.
The element to be removed
Protected_ProtectedRender buttons that are inserted directly into the frame header. Header controls should be preferred over frame buttons, which should be used sparingly.
Options which configure application rendering behavior.
Protected_ProtectedRender a header control button.
Protected_ProtectedAdd headings to the table of contents for the given node.
The HTML node of the page's rendered contents.
The page's table of contents.
Protected_ProtectedRender the page view for a page sheet.
The existing page element in the journal entry view.
The page sheet.
Protected_ProtectedUpdate child views inside the main sheet.
Protected_ProtectedUpdate 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.
Optionaloptions: any = {}Protected_ProtectedIf 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.
Protected_ProtectedDisable or reenable all form fields in this application.
Should the fields be disabled?
Protected_ProtectedUpdate the disabled state of the previous and next page buttons.
Protected_ProtectedTranslate a requested application position updated into a resolved allowed position for the Application. Subclasses may override this method to implement more advanced positioning behavior.
Requested Application positioning data
Resolved Application positioning data
Static_InternalProvide a deprecation path for converted V1 document sheets.
The first parameter received by this class's constructor
Any additional parameters received
StaticinheritanceIterate over the inheritance chain of this Application. The chain includes this Application itself and all parents until the base application is encountered.
StaticinstancesIterate over the instances of this Application.
StaticparseParse a CSS style rule into a number of pixels which apply to that dimension.
The CSS style rule
The relevant dimension of the parent element
The parsed style dimension in pixels
StaticwaitWait for any images in the given element to load.
The element.
The Application responsible for displaying and editing a single JournalEntry Document.
Mixes
HandlebarsApplication