Class AbstractListSelectorAbstract

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

Hierarchy (View Summary)

Indexable

  • [key: string]: any

Constructors

constructor

Properties

dragDropHighlightTimeout DEFAULT_OPTIONS

Accessors

attribute dataCount dragDropType dtypes fields

Methods

_canDragDrop _canDragStart _getNewEntry _getUpdateData _onChangeForm _onDragOver _onDragStart _onDrop _onRender _preparePartContext clearDragHighlights _onAddEntry _onDeleteEntry _save

Constructors

constructor

Properties

dragDropHighlightTimeout

dragDropHighlightTimeout: null | Timeout

StaticDEFAULT_OPTIONS

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

Accessors

attribute

dataCount

dragDropType

dtypes

fields

Methods

Protected_canDragDrop

  • _canDragDrop(selector: string): boolean
  • Protected

    Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector

    Parameters

    • selector: string

      The candidate HTML selector for the drop target

    Returns boolean

    Can the current user drop on this selector?

Protected_canDragStart

Protected Abstract_getNewEntry

Protected Abstract_getUpdateData

_onChangeForm

  • _onChangeForm(...this: any, formConfig: any, event: any): Promise<void>
  • Internal

    Update internal data snapshot on form change

    Parameters

    • ...this: any
    • formConfig: any
    • event: any

    Returns Promise<void>

Protected_onDragOver

Protected_onDragStart

Protected_onDrop

_onRender

_preparePartContext

  • _preparePartContext(
        partId: any,
    ): Promise<
        | {
            buttons?: undefined;
            cssClass: string;
            document: any;
            dtypes: string[];
            editable: any;
            entries: any;
            fields: string[];
            id: any;
        }
        | {
            buttons?: undefined;
            cssClass?: undefined;
            document?: undefined;
            dtypes?: undefined;
            editable?: undefined;
            entries?: undefined;
            fields?: undefined;
            id?: undefined;
        }
        | {
            buttons: { icon: string; label: string; type: string }[];
            cssClass?: undefined;
            document?: undefined;
            dtypes?: undefined;
            editable?: undefined;
            entries?: undefined;
            fields?: undefined;
            id?: undefined;
        },
    >
  • Internal

    Parameters

    • partId: any

    Returns Promise<
        | {
            buttons?: undefined;
            cssClass: string;
            document: any;
            dtypes: string[];
            editable: any;
            entries: any;
            fields: string[];
            id: any;
        }
        | {
            buttons?: undefined;
            cssClass?: undefined;
            document?: undefined;
            dtypes?: undefined;
            editable?: undefined;
            entries?: undefined;
            fields?: undefined;
            id?: undefined;
        }
        | {
            buttons: { icon: string; label: string; type: string }[];
            cssClass?: undefined;
            document?: undefined;
            dtypes?: undefined;
            editable?: undefined;
            entries?: undefined;
            fields?: undefined;
            id?: undefined;
        },
    >

    Inherit Doc

    Async

clearDragHighlights

Static_onAddEntry

Static_onDeleteEntry

Static_save

  • _save(
        ...this: any,
        event: SubmitEvent,
        form: HTMLFormElement,
        formData: FormDataExtended,
    ): Promise<void>
  • Internal

    Save the new data back to the document.

    Parameters

    • ...this: any
    • event: SubmitEvent

      The originating form submission event

    • form: HTMLFormElement

      The form element that was submitted

    • formData: FormDataExtended

      Processed data for the submitted form

      • object

        The object of the form

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods