Class AbstractListSelector

Offers a dynamic list selector that allows the user to add new entries and delete existing entries

Abstract

Hierarchy

Constructors

constructor

Properties

dragDropHighlightTimeout DEFAULT_OPTIONS

Accessors

attribute dataCount dragDropType dtypes fields

Methods

_getNewEntry _getUpdateData _onChangeForm _onDragOver _onDragStart _onDrop _prepareContext clearDragHighlights _onAddEntry _onDeleteEntry _save

Constructors

constructor

Properties

dragDropHighlightTimeout

dragDropHighlightTimeout: null | Timeout

Static DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: {
        addEntry: ((event) => Promise<void>);
        deleteEntry: ((event) => Promise<void>);
    };
    classes: string[];
    dragDrop: {
        dragSelector: string;
        dropSelector: string;
    }[];
    form: {
        closeOnSubmit: boolean;
        handler: ((event, form, formData) => Promise<void>);
        submitOnClose: boolean;
    };
    position: {
        width: number;
    };
    sheetConfig: boolean;
    tag: string;
    window: {
        minimizable: boolean;
        resizable: boolean;
    };
} = ...

Type declaration

  • actions: {
        addEntry: ((event) => Promise<void>);
        deleteEntry: ((event) => Promise<void>);
    }
    • addEntry: ((event) => Promise<void>)
        • (event): Promise<void>
        • Internal

          Add a new entry to the list

          Parameters

          • event: any

          Returns Promise<void>

          Static

    • deleteEntry: ((event) => Promise<void>)
        • (event): Promise<void>
        • Internal

          Delete an existing entry from the list

          Parameters

          • event: any

          Returns Promise<void>

          Static

  • classes: string[]
  • dragDrop: {
        dragSelector: string;
        dropSelector: string;
    }[]
  • form: {
        closeOnSubmit: boolean;
        handler: ((event, form, formData) => Promise<void>);
        submitOnClose: boolean;
    }
    • closeOnSubmit: boolean
    • handler: ((event, form, formData) => Promise<void>)
        • (event, form, formData): Promise<void>
        • Internal

          Save the new data back to the document.

          Parameters

          • event: SubmitEvent

            The originating form submission event

          • form: HTMLFormElement

            The form element that was submitted

          • formData: FormDataExtended

            Processed data for the submitted form

          Returns Promise<void>

    • submitOnClose: boolean
  • position: {
        width: number;
    }
    • width: number
  • sheetConfig: boolean
  • tag: string
  • window: {
        minimizable: boolean;
        resizable: boolean;
    }
    • minimizable: boolean
    • resizable: boolean

Accessors

attribute

dataCount

dragDropType

dtypes

fields

Methods

Protected _getNewEntry

Protected _getUpdateData

_onChangeForm

Protected _onDragOver

Protected _onDragStart

Protected _onDrop

_prepareContext

  • _prepareContext(): Promise<{
        buttons: {
            icon: string;
            label: string;
            type: string;
        }[];
        document: any;
        dtypes: string[];
        entries: any;
        fields: string[];
        id: any;
    }>
  • Internal

    Returns Promise<{
        buttons: {
            icon: string;
            label: string;
            type: string;
        }[];
        document: any;
        dtypes: string[];
        entries: any;
        fields: string[];
        id: any;
    }>

    Inherit Doc

    Async

clearDragHighlights

Static _onAddEntry

Static _onDeleteEntry

Static _save

  • _save(event, form, formData): Promise<void>
  • Internal

    Save the new data back to the document.

    Parameters

    • event: SubmitEvent

      The originating form submission event

    • form: HTMLFormElement

      The form element that was submitted

    • formData: FormDataExtended

      Processed data for the submitted form

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc