Class AbstractListSelector`Abstract`

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

Hierarchy (View Summary)

any
- AbstractListSelector
  - EntrySelector

Index

Constructors

constructor

new AbstractListSelector(options?: {}): AbstractListSelector
Parameters
- options: {} = {}
Returns AbstractListSelector
Overrides DragDropApplicationMixin(HandlebarsApplicationMixin(DocumentSheetV2)).constructor
- Defined in module/applications/abstract-list-selector.mjs:35

Properties

dragDropHighlightTimeout

dragDropHighlightTimeout: null | Timeout

`Static`DEFAULT_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

get attribute(): string
Alias the name property

Returns string
- Defined in module/applications/abstract-list-selector.mjs:158

dataCount

get dataCount(): number
Get the data entry length

Returns number
- Defined in module/applications/abstract-list-selector.mjs:191

dragDropType

get dragDropType(): string
Return the dragdrop element type for this application

Returns string
- Defined in module/applications/abstract-list-selector.mjs:47

dtypes

get dtypes(): string[]
Get the list of data types

Returns string[]
- Defined in module/applications/abstract-list-selector.mjs:180

fields

get fields(): string[]
Get the list of fields

Returns string[]
- Defined in module/applications/abstract-list-selector.mjs:169

Methods

`Protected` `Abstract`_getNewEntry

_getNewEntry(event: any): object
Protected
Provides default data for a new list entry
Parameters
- event: any
Returns object
- Defined in module/applications/abstract-list-selector.mjs:205

`Protected` `Abstract`_getUpdateData

_getUpdateData(): object
Protected
Provides update data for saves

Returns object
- Defined in module/applications/abstract-list-selector.mjs:270

_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>
- Defined in module/applications/abstract-list-selector.mjs:259

`Protected`_onDragOver

_onDragOver(event: DragEvent): void
Protected
Highlight position that the element will be inserted to on drop
Parameters
- event: DragEvent
  The originating DragEvent
Returns void
- Defined in module/applications/abstract-list-selector.mjs:90

`Protected`_onDragStart

_onDragStart(event: DragEvent): void
Protected
Prepare drag-drop data and highlight dragged element
Parameters
- event: DragEvent
  The originating DragEvent
Returns void
- Defined in module/applications/abstract-list-selector.mjs:59

`Protected`_onDrop

_onDrop(event: DragEvent): Promise<void>
Protected
Inject dragged element into its new position
Parameters
- event: DragEvent
  The originating DragEvent
Returns Promise<void>
- Defined in module/applications/abstract-list-selector.mjs:114

_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
- Defined in module/applications/abstract-list-selector.mjs:140

clearDragHighlights

clearDragHighlights(): void
Returns void
- Defined in module/applications/abstract-list-selector.mjs:102

`Static`_onAddEntry

_onAddEntry(...this: any, event: any): Promise<void>
Internal
Add a new entry to the list
Parameters
- ...this: any
- event: any
Returns Promise<void>
Static
- Defined in module/applications/abstract-list-selector.mjs:220

`Static`_onDeleteEntry

_onDeleteEntry(...this: any, event: any): Promise<void>
Internal
Delete an existing entry from the list
Parameters
- ...this: any
- event: any
Returns Promise<void>
Static
- Defined in module/applications/abstract-list-selector.mjs:237

`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>
- Defined in module/applications/abstract-list-selector.mjs:287

Class AbstractListSelectorAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AbstractListSelector

Properties

dragDropHighlightTimeout

StaticDEFAULT_OPTIONS

Accessors

attribute

Returns string

dataCount

Returns number

dragDropType

Returns string

dtypes

Returns string[]

fields

Returns string[]

Methods

Protected Abstract_getNewEntry

Parameters

Returns object

Protected Abstract_getUpdateData

Returns object

_onChangeForm

Parameters

Returns Promise<void>

Protected_onDragOver

Parameters

Returns void

Protected_onDragStart

Parameters

Returns void

Protected_onDrop

Parameters

Returns Promise<void>

_prepareContext

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

Inherit Doc

Async

clearDragHighlights

Returns void

Static_onAddEntry

Parameters

Returns Promise<void>

Static

Static_onDeleteEntry

Parameters

Returns Promise<void>

Static

Static_save

Parameters

object

Returns Promise<void>

Settings

On This Page

Class AbstractListSelector`Abstract`

`Static`DEFAULT_OPTIONS

`Protected` `Abstract`_getNewEntry

`Protected` `Abstract`_getUpdateData

`Protected`_onDragOver

`Protected`_onDragStart

`Protected`_onDrop

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

`Static`_onAddEntry

`Static`_onDeleteEntry

`Static`_save