Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class AbstractListSelectorAbstract

    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,
      >
    Index

    Constructors

    constructor

    Properties

    dragDropHighlightTimeout DEFAULT_OPTIONS

    Accessors

    attribute dataCount dragDropType dtypes fields

    Methods

    _getNewEntry _getUpdateData _onChangeForm _onClose _onDragOver _onDragStart _onDrop _onRender _preClose _preparePartContext clearDragHighlights _onAddEntry _onCommitChanges _onDeleteEntry

    Constructors

    • Parameters

      • Optionaloptions: {}

      Returns AbstractListSelector

    Properties

    dragDropHighlightTimeout: null
    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>;
        };
        position: { width: number };
        sheetConfig: boolean;
        tag: string;
        window: { minimizable: boolean; resizable: boolean };
    } = ...

    Accessors

    • get attribute(): string

      Alias the name property

      Returns string

    • get dataCount(): number

      Get the data entry length

      Returns number

    • get dragDropType(): string

      Return the dragdrop element type for this application

      Returns string

    • get dtypes(): string[]

      Get the list of data types

      Returns string[]

    • get fields(): string[]

      Get the list of fields

      Returns string[]

    Methods

    Protected Abstract_getNewEntry

    • _getNewEntry(event: any): object
      Protected

      Provides default data for a new list entry

      Parameters

      • event: any

      Returns object

    Protected Abstract_getUpdateData

    • _getUpdateData(): object
      Protected

      Provides update data for saves

      Returns object

    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>

    _onClose

    • _onClose(options: any): void

      Parameters

      • options: any

      Returns void

    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

    Protected_onDragStart

    • _onDragStart(event: DragEvent): void
      Protected

      Prepare drag-drop data and highlight dragged element

      Parameters

      • event: DragEvent

        The originating DragEvent

      Returns void

    Protected_onDrop

    • _onDrop(event: DragEvent): Promise<void>
      Protected

      Inject dragged element into its new position

      Parameters

      • event: DragEvent

        The originating DragEvent

      Returns Promise<void>

    _onRender

    • _onRender(context: any, options: any): void

      Parameters

      • context: any
      • options: any

      Returns void

    _preClose

    • _preClose(options: any): Promise<void>

      Parameters

      • options: any

      Returns Promise<void>

    _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;
          },
      >

    • Returns void

    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_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>

    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>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods