Class AbstractDocumentSelectorAbstract

An abstract class for a document selector application.

Hierarchy (View Summary)

Constructors

constructor

Properties

DEFAULT_OPTIONS PARTS

Accessors

documents promise selected

Methods

_onClose _onRender _prepareContext wait

Constructors

constructor

Properties

StaticDEFAULT_OPTIONS

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

StaticPARTS

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

Accessors

documents

promise

selected

Methods

_onClose

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: string };
                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: string };
                include: any;
            };
            searchTerm: any;
            sections: DocumentSelectorSection[];
            selected: string;
            showSectionHeaders: boolean;
        },
    >

    Inherit Doc

Staticwait

  • wait(
        options: object,
    ): Promise<null | string | false | Document<any, null, Metadata<any>>>

  • Render selector and wait for it to resolve.

    Parameters

    • options: object

      Options

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

    • 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