Class CompendiumBrowser`Abstract`

The basic compendium browser class allowing the browsing of compendiums by utilising their indexes.

Extending classes must define the following static properties if the browser is not meant to browse Item documents: documentName. Extending classes should define the following static properties: typeName, filterClasses.

Hierarchy (View Summary)

any
- CompendiumBrowser

Constructors

constructor

new CompendiumBrowser(options?: {}): CompendiumBrowser
Parameters
- options: {} = {}
Returns CompendiumBrowser
Overrides HandlebarsApplicationMixin(ApplicationV2).constructor
- Defined in module/applications/compendium-browser/compendium-browser.mjs:114

Properties

_boundResetDragHide

_boundResetDragHide: () => void

_debouncedRender

_debouncedRender: (...args: any) => void

_dragDrop

_dragDrop: any

_entries

_entries: undefined | IndexEntry[]

`Readonly`entries

entries: Collection<IndexEntry>

The Collection of index entries this browser is aware of.

expandedFilters

expandedFilters: Set<string> = ...

A set of filters that were expanded by the user, and should stay expanded upon re-render.

filters

filters: Collection<BaseFilter> = ...

The set of filters to apply to the compendium index.

handledTypes

handledTypes: Set<string> = ...

The types of entries this browser handles, as per a document's type property.

packs

packs: CompendiumCollection<any>[] = []

Compendium packs this browser gets entries from.

`Static`_query

_query: undefined | string

`Static` `Internal`BROWSERS

BROWSERS: {} = {}

Known browsers.

Initialized in initializeBrowsers

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: {
        clearFilter: (event: PointerEvent, button: HTMLElement) => void;
        reloadPacks: Object;
        resetFilters: Object;
    };
    classes: string[];
    id: string;
    position: { height: number; left: number; top: number; width: number };
    tag: string;
    window: { icon: string; resizable: boolean };
} = ...

`Static` `Abstract`documentName

documentName: "Actor" | "Item" = "Item"

The document name of entries this browser displays.

`Static`ENTRY_TEMPLATE

ENTRY_TEMPLATE: string = "systems/pf1/templates/apps/compendium-browser/entries.hbs"

The template used to render individual entries in the browser.

`Static`filterClasses

filterClasses: typeof BaseFilter[] = []

An array of classes extending BaseFilter that should be used for this browser.

`Static`PARTS

PARTS: { form: { scrollable: string[]; template: string } } = ...

`Static` `Abstract`typeName

typeName: string

A localisation string used in the browser's title.

Accessors

title

get title(): string
Returns string
Inherit Doc
- Defined in module/applications/compendium-browser/compendium-browser.mjs:271

Methods

_activateFilterQueue

_activateFilterQueue(): void
Internal Experimental
Enable queued filters

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:308

_canDragStart

_canDragStart(selector: any): boolean
Parameters
- selector: any
Returns boolean
Inherit Doc
- Defined in module/applications/compendium-browser/compendium-browser.mjs:674

`Protected`_getEntryContextOptions

_getEntryContextOptions(): object[]
Protected
Get the set of ContextMenu options which should be used for the compendium browser's entries.

Returns object[]
- The Array of ContextMenu options
- Defined in module/applications/compendium-browser/compendium-browser.mjs:642

_initDragDrop

_initDragDrop(html: HTMLElement): void
Parameters
- html: HTMLElement
Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:776

_initializeApplicationOptions

_initializeApplicationOptions(options: any): any
Parameters
- options: any
Returns any
- Defined in module/applications/compendium-browser/compendium-browser.mjs:153

_onDragStart

_onDragStart(event: any): void
Parameters
- event: any
Returns void
Inherit Doc
- Defined in module/applications/compendium-browser/compendium-browser.mjs:679

_onFirstRender

_onFirstRender(context: any, options: any): Promise<void>
Parameters
- context: any
- options: any
Returns Promise<void>
- Defined in module/applications/compendium-browser/compendium-browser.mjs:536

_onRender

_onRender(context: any, options: any): void
Parameters
- context: any
- options: any
Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:546

_preparePartContext

_preparePartContext(partId: any, context: any, options: any): Promise<any>
Parameters
- partId: any
- context: any
- options: any
Returns Promise<any>
Inherit Doc
- Defined in module/applications/compendium-browser/compendium-browser.mjs:466

_preSyncPartState

_preSyncPartState(
    partId: string,
    newElement: HTMLElement,
    priorElement: HTMLElement,
    state: object,
): void
Parameters
- partId: string
- newElement: HTMLElement
- priorElement: HTMLElement
- state: object
Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:504

_queueFilters

_queueFilters(filters: object): void
Internal Experimental
Queue filters to be processed by _activateFilterQueue

Only one filter bundle is ever queued.
Parameters
- filters: object
Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:358

_resetDragHide

_resetDragHide(): void
Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:719

_startGlobalListeners

_startGlobalListeners(): void
Internal
Add global listeners

Comprehensive listeners for ensuring the drag end event is caught.

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:702

_stopGlobalListeners

_stopGlobalListeners(): void
Internal
Remove global listeners

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:713

_syncPartState

_syncPartState(
    partId: string,
    newElement: HTMLElement,
    priorElement: HTMLElement,
    state: object,
): void
Parameters
- partId: string
- newElement: HTMLElement
- priorElement: HTMLElement
- state: object
Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:523

getFilteredEntries

getFilteredEntries(): IndexEntry[]
Get the current set of entries allowed by the filters.

Returns IndexEntry[]
The filtered entries
- Defined in module/applications/compendium-browser/compendium-browser.mjs:440

`Protected`initialize

initialize(): void
Protected
Perform minimal preparation steps to initialize the compendium browser. Add filters and determine which compendiums include data relevant to this browser.

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:281

isPackIncluded

isPackIncluded(pack: CompendiumCollection<any>): boolean
Check whether a compendium should be included in the browser.
Parameters
- pack: CompendiumCollection<any>
  The compendium to test
Returns boolean
Whether the compendium should be included
- Defined in module/applications/compendium-browser/compendium-browser.mjs:374

loadPackIndex

loadPackIndex(pack: CompendiumCollection<any>): Promise<IndexEntry[]>
Load a compendium's index to prepare it for browsing.
Parameters
- pack: CompendiumCollection<any>
  The compendium to load
Returns Promise<IndexEntry[]>
The loaded index entries
- Defined in module/applications/compendium-browser/compendium-browser.mjs:414

setup

setup(): Promise<void>
Perform the initial setup of the compendium browser. This includes requesting the index of all relevant compendiums if necessary and preparing the filters.

Returns Promise<void>
- Defined in module/applications/compendium-browser/compendium-browser.mjs:396

`Static`_mapEntry

_mapEntry(entry: object, pack: CompendiumCollection<any>): IndexEntry
Map an entry from a compendium to the format used by the browser.
Parameters
- entry: object
  The entry to map
- pack: CompendiumCollection<any>
  The compendium the entry is from
Returns IndexEntry
The mapped entry
- Defined in module/applications/compendium-browser/compendium-browser.mjs:236

`Protected` `Static`_onClearFilter

_onClearFilter(event: PointerEvent, button: HTMLElement): void
Protected
Clear singular filter
Parameters
- event: PointerEvent
- button: HTMLElement
Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:596

`Static`getIndexes

getIndexes(packNames?: string[]): Promise<void>
Request indexes of all packs of a document type to be loaded. This method should only ever be called as CompendiumBrowser.getIndexes to ensure Promises are properly bundled.
Parameters
- packNames: string[] = []
  The names of the packs to load indexes for
Returns Promise<void>
A Promise that resolves once all indexes have been loaded

See
CompendiumBrowser.#indexingPromise
- Defined in module/applications/compendium-browser/compendium-browser.mjs:213

`Static`initializeBrowsers

initializeBrowsers(): void
Initialize all CompendiumBrowsers found in pf1.applications.compendiumBrowser and register them in pf1.applications.compendiums.

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:198

`Static`registerDefault

registerDefault(): void
Internal
Fill BROWSERS

Called in init hook.

Returns void
- Defined in module/applications/compendium-browser/compendium-browser.mjs:184

Class CompendiumBrowserAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CompendiumBrowser

Properties

_boundResetDragHide

_debouncedRender

_dragDrop

_entries

Readonlyentries

expandedFilters

filters

handledTypes

packs

Static_query

Static InternalBROWSERS

StaticDEFAULT_OPTIONS

Static AbstractdocumentName

StaticENTRY_TEMPLATE

StaticfilterClasses

StaticPARTS

Static AbstracttypeName

Accessors

title

Returns string

Inherit Doc

Methods

_activateFilterQueue

Returns void

_canDragStart

Parameters

Returns boolean

Inherit Doc

Protected_getEntryContextOptions

Returns object[]

_initDragDrop

Parameters

Returns void

_initializeApplicationOptions

Parameters

Returns any

_onDragStart

Parameters

Returns void

Inherit Doc

_onFirstRender

Parameters

Returns Promise<void>

_onRender

Parameters

Returns void

_preparePartContext

Parameters

Returns Promise<any>

Inherit Doc

_preSyncPartState

Parameters

Returns void

_queueFilters

Parameters

Returns void

_resetDragHide

Returns void

_startGlobalListeners

Returns void

_stopGlobalListeners

Returns void

_syncPartState

Parameters

Returns void

getFilteredEntries

Returns IndexEntry[]

Protectedinitialize

Class CompendiumBrowser`Abstract`

`Readonly`entries

`Static`_query

`Static` `Internal`BROWSERS

`Static`DEFAULT_OPTIONS

`Static` `Abstract`documentName

`Static`ENTRY_TEMPLATE

`Static`filterClasses

`Static`PARTS

`Static` `Abstract`typeName

`Protected`_getEntryContextOptions

`Protected`initialize

`Static`_mapEntry

`Protected` `Static`_onClearFilter

`Static`getIndexes

`Static`initializeBrowsers

`Static`registerDefault