Class AbstractDocumentSelectorAbstract

An abstract class for a document selector application.

Hierarchy (View Summary)

Constructors

constructor

Properties

selected DEFAULT_OPTIONS PARTS

Methods

_onChangeForm _onRender _prepareContext wait

Constructors

constructor

Properties

selected

selected: any

The currently selected document ID

StaticDEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    classes: string[];
    form: {
        closeOnSubmit: boolean;
        handler: Object;
        submitOnChange: boolean;
        submitOnClose: boolean;
    };
    includeNone: string;
    position: { width: number };
    search: {
        compositioning: boolean;
        delay: number;
        effectiveSearch: string;
        event: null;
        value: string;
    };
    sheetConfig: boolean;
    tag: string;
    window: { minimizable: boolean; resizable: boolean; title: string };
} = ...

StaticPARTS

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

Methods

_onChangeForm

  • _onChangeForm(formConfig: ApplicationFormConfiguration, event: Event): void
  • Internal

    The event handler for changes to form input elements

    Parameters

    • formConfig: ApplicationFormConfiguration

      The configuration of the form being changed

    • event: Event

      The triggering event

    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;
            none: {
                document: { id: string; img: string; name: string };
                include: any;
            };
            searchTerm: any;
            sections: DocumentSelectorSection[];
            selected: any;
            showSectionHeaders: boolean;
        },
    >
  • Internal

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

    Inherit Doc

    Async

Staticwait

Settings

Member Visibility

On This Page

Constructors
Properties
Methods