Initialize the content of the directory by categorizing folders and documents into a hierarchical tree structure.
Handle changes to search filtering controllers which are bound to the Application
The key-up event from keyboard input
The raw string input to the search field
The regular expression to test against
The HTML element which should be filtered
Collapse all subfolders in this directory
After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.
Highlight folders as drop targets when a drag event enters or exits their area
The DragEvent which is in progress
Activate this SidebarTab, switching focus to it
Create a second instance of this SidebarTab class which represents a singleton popped-out container
The popped out sidebar tab instance
Render the SidebarTab as a pop-out container
Handle lazy loading for sidebar images to only load them once they become observed
The entries which are now observed
The intersection observer instance
Render the Application by evaluating it's HTML template against the object of data provided by the getData method If the Application is rendered as a pop-out window, wrap the contained HTML in an outer frame with window controls
Add the rendered application to the DOM if it is not already present. If false, the Application will only be re-rendered if it is already present.
Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.
The rendered Application instance
Change the currently active tab
The target tab name to switch to
Options which configure changing the tab
A specific named tab group, useful if multiple sets of tabs are present
Whether to trigger tab-change callback functions
Bring the application to the top of the rendering stack
Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized
A Promise which resolves once the minimization action has completed
Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized
A Promise which resolves once the maximization action has completed
Set the application position and store its new location. Returns the updated position object for the application containing the new values.
Positional data
The left offset position in pixels
The top offset position in pixels
The application width in pixels
The application height in pixels
The application scale as a numeric factor where 1.0 is default
|void}
Handle clicking on a Document name in the Sidebar directory
The originating click event
Handle new Document creation request
The originating button click event
Create a new Folder in this SidebarDirectory
The originating button click event
Handle toggling the collapsed or expanded state of a folder within the directory tab
The originating click event
Handle Document data being dropped into the directory.
The target element
The data being dropped
Handle Folder data being dropped into the directory.
The target element
The data being dropped
Get the set of ContextMenu options which should be used for Folders in a SidebarDirectory
The Array of context options passed to the ContextMenu instance
Persist the scroll positions of containers within the app before re-rendering the content
The HTML object being traversed
Restore the scroll positions of containers within the app after re-rendering the content
The HTML object being traversed
Render the outer application wrapper
A promise resolving to the constructed jQuery object
Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.
Handle changes to the active tab in a configured Tabs controller
A left click event
The Tabs controller
The new active tab name
Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector
The candidate HTML selector for the drop target
Can the current user drop on this selector?
Callback actions which occur when a dragged element is over a drop target.
The originating DragEvent
Given a Document type and a list of Document instances, set up the Folder tree
The Array of Folder objects to organize
The Array of Document objects to organize
A tree structure containing the folders and documents
References to the set of Documents which are displayed in the Sidebar
Reference the set of Folders which exist in this Sidebar
The base name of this sidebar tab
Denote whether this is the original version of the sidebar tab, or a pop-out variant
The options provided to this application upon initialization
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
An internal reference to the HTML element this application renders
Track the current position and dimensions of the Application UI
DragDrop workflow handlers which are active for this Application
Tab navigation handlers which are active for this Application
SearchFilter handlers which are active for this Application
Track whether the Application is currently minimized
Track the most recent scroll positions for any vertically scrolling containers
A reference to the pop-out variant of this SidebarTab, if one exists
The current render state of the Application
The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.
The path to the template partial which renders a single Document within this directory
The path to the template partial which renders a single Folder within this directory
The sequence of rendering states that track the Application life-cycle.
Return the active application element, if it currently exists in the DOM
The path to the HTML template file which should be used to render the inner content of the app
Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered
Return a flag for whether the Application instance is currently rendered
An Application window should define its own title definition logic which may be dynamic depending on its data
The WorldCollection instance which this Sidebar Directory displays.
The sidebar directory which organizes and displays world-level JournalEntry documents.