Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class AbstractDocumentSelectorAbstract

    An abstract class for a document selector application.

    Hierarchy (View Summary)

    • HandlebarsApplication<this> & ApplicationV2<
          RenderContext,
          Configuration,
          RenderOptions,
          this,
      >
    Index

    Constructors

    constructor

    Properties

    DEFAULT_OPTIONS PARTS

    Accessors

    documents promise selected

    Methods

    _onClose _onRender _prepareContext wait

    Constructors

    • Parameters

      • options: any

      Returns AbstractDocumentSelector

    Properties

    DEFAULT_OPTIONS: {
        classes: string[];
        empty: string;
        form: { closeOnSubmit: boolean; handler: Object; submitOnChange: boolean };
        position: { width: number };
        sheetConfig: boolean;
        tag: string;
        window: { minimizable: boolean; resizable: boolean; title: string };
    } = ...
    PARTS: {
        footer: { template: string };
        form: { scrollable: string[]; template: string };
    } = ...

    Accessors

    • get documents(): Document<any, any, null>[]

      Returns Document<any, any, null>[]

    • get promise(): Promise<any>

      Returns Promise<any>

    • get selected(): string

      Returns string

    Methods

    _onClose

    • _onClose(options: any): void

      Actions performed after closing the Application. Post-close steps are not awaited by the close process.

      Parameters

      • options: any

        Provided render options

      Returns void

    Protected_onRender

    • _onRender(context: ApplicationRenderContext, options: RenderOptions): void
      Protected

      Attach event listeners to the rendered application form.

      Parameters

      • context: ApplicationRenderContext

        Prepared context data

      • options: RenderOptions

        Provided render options

      Returns void

    _prepareContext

    • _prepareContext(): Promise<
          {
              buttons: { label: string; type: string }[];
              document: any;
              empty: { document: { id: string; img: string; name: any }; include: any };
              searchTerm: any;
              sections: DocumentSelectorSection[];
              selected: string;
              showSectionHeaders: boolean;
          },
      >
      Internal

      Returns Promise<
          {
              buttons: { label: string; type: string }[];
              document: any;
              empty: { document: { id: string; img: string; name: any }; include: any };
              searchTerm: any;
              sections: DocumentSelectorSection[];
              selected: string;
              showSectionHeaders: boolean;
          },
      >

    • Render selector and wait for it to resolve.

      Parameters

      • options: object

        Options

      Returns Promise<null | string | false | Document<any, any, null>>

      • Document or string for selected item, null if cancelled, or false or empty string if none were selected.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods