References to the set of Documents which are displayed in the Sidebar
Reference the set of Folders which exist in this Sidebar
Denote whether this is the original version of the sidebar tab, or a pop-out variant
The options provided to this application upon initialization
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
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
Protected _popoutA reference to the pop-out variant of this SidebarTab, if one exists
Protected _stateThe current render state of the Application
Protected _priorThe prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.
Static entryStatic documentA reference to the named Document type that this Sidebar Directory instance displays
Static RENDER_The sequence of rendering states that track the Application life-cycle.
An Application window should define its own title definition logic which may be dynamic depending on its data
The base name of this sidebar tab
A convenience redirection back to the metadata object of the associated CompendiumCollection
The collection of Documents which are displayed in this Sidebar Directory
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
Whether the Application is currently closing.
Static defaultStatic collectionThe WorldCollection instance which this Sidebar Directory displays.
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
Create a second instance of this SidebarTab class which represents a singleton popped-out container
The popped out sidebar tab 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
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
Protected _createProtected _createProtected Create a list of documents in a dropped Folder
The Folder being dropped
The documents to create
Protected _callProtected Internal Call all hooks for all applications in the inheritance chain.
The hook being triggered, which formatted with the Application class name
Rest ...hookArgs: any[]The arguments passed to the hook calls
Protected _saveProtected _restoreProtected _renderProtected _getProtected Specify the set of config buttons which should appear in the Application header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.
getApplicationHeaderButtons
Protected _activateProtected _onProtected Handle changes to the active tab in a configured Tabs controller
A left click event
The Tabs controller
The new active tab name
Protected _onProtected 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
Protected _canProtected _canProtected _onProtected _onProtected _wait
An interface for displaying the content of a CompendiumCollection.
Param: collection
The CompendiumCollection object represented by this interface.
Param: options
Application configuration options.