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

    Accessors

    attribute dataCount dragDropType dtypes fields

    Methods

    _getNewEntry _getUpdateData clearDragHighlights _onAddEntry _onCommitChanges _onDeleteEntry

    Constructors

    • Parameters

      • Optionaloptions: {}

      Returns AbstractListSelector

    Properties

    dragDropHighlightTimeout: null

    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

    • 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