Class AbstractListSelector`Abstract`

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

Hierarchy (View Summary)

HandlebarsApplication<this> & DocumentSheetV2<
    any,
    RenderContext<any>,
    Configuration<any>,
    RenderOptions,
    this,
>
- AbstractListSelector
  - DamageResistanceSelector
  - EntrySelector

Index

Constructors

constructor

new AbstractListSelector(options?: {}): AbstractListSelector
Parameters
- Optionaloptions: {}
Returns AbstractListSelector
Inherited from DragDropApplicationMixin(HandlebarsApplicationMixin(DocumentSheetV2)).constructor
- Defined in node_modules/fvtt-types/src/foundry/client/applications/api/document-sheet.d.mts:90

Properties

dragDropHighlightTimeout

dragDropHighlightTimeout: null

`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:198

dataCount

get dataCount(): number
Get the data entry length

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

dragDropType

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

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

dtypes

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

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

fields

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

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

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:245

`Protected` `Abstract`_getUpdateData

_getUpdateData(): object
Protected
Provides update data for saves

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

`Protected`_onChangeForm

_onChangeForm(...this: any, formConfig: any, event: any): Promise<void>
Protected
Update internal data snapshot on form change
Parameters
- ...this: any
- formConfig: any
- event: any
Returns Promise<void>
Overrides DragDropApplicationMixin(HandlebarsApplicationMixin(DocumentSheetV2))._onChangeForm
- Defined in module/applications/abstract-list-selector.mjs:297

_onClose

_onClose(options: any): void
Parameters
- options: any
Returns void
Overrides DragDropApplicationMixin(HandlebarsApplicationMixin(DocumentSheetV2))._onClose
- Defined in module/applications/abstract-list-selector.mjs:50

`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:102

`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:65

`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:128

_onRender

_onRender(context: any, options: any): void
Parameters
- context: any
- options: any
Returns void
Overrides DragDropApplicationMixin(HandlebarsApplicationMixin(DocumentSheetV2))._onRender
- Defined in module/applications/abstract-list-selector.mjs:180

_preClose

_preClose(options: any): Promise<void>
Parameters
- options: any
Returns Promise<void>
Overrides DragDropApplicationMixin(HandlebarsApplicationMixin(DocumentSheetV2))._preClose
- Defined in module/applications/abstract-list-selector.mjs:330

_preparePartContext

_preparePartContext(
    partId: any,
): Promise<
    | {
        buttons?: undefined;
        cssClass: string;
        document: any;
        dtypes: string[];
        editable: boolean;
        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: boolean;
        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
Overrides DragDropApplicationMixin(HandlebarsApplicationMixin(DocumentSheetV2))._preparePartContext
- Defined in module/applications/abstract-list-selector.mjs:153

clearDragHighlights

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

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

`Static`_onCommitChanges

_onCommitChanges(
    ...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:325

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

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

Protected_onChangeForm

Parameters

Returns Promise<void>

_onClose

Parameters

Returns void

Protected_onDragOver

Parameters

Returns void

Protected_onDragStart

Parameters

Returns void

Protected_onDrop

Parameters

Returns Promise<void>

_onRender

Parameters

Returns void

_preClose

Parameters

Returns Promise<void>

_preparePartContext

Parameters

Inherit Doc

clearDragHighlights

Returns void

Static_onAddEntry

Parameters

Returns Promise<void>

Static_onCommitChanges

Parameters

object

Returns Promise<void>

Static_onDeleteEntry

Parameters

Returns Promise<void>

Settings

On This Page

Class AbstractListSelector`Abstract`

`Static`DEFAULT_OPTIONS

`Protected` `Abstract`_getNewEntry

`Protected` `Abstract`_getUpdateData

`Protected`_onChangeForm

`Protected`_onDragOver

`Protected`_onDragStart

`Protected`_onDrop

`Static`_onAddEntry

`Static`_onCommitChanges

`Static`_onDeleteEntry