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

    Class EntrySelector

    An application that allows the user to configure change flags on an item

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    choices dragDropHighlightTimeout entries isBoolean isFlag isFlat originalEntries subtitle DEFAULT_OPTIONS PARTS

    Accessors

    attribute dataCount dragDropType dtypes fields title

    Methods

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

    Constructors

    Properties

    choices: undefined | string[] | Record<string, string>

    The options for the datalist element.

    dragDropHighlightTimeout: null
    entries: {}
    isBoolean: boolean
    isFlag: boolean
    isFlat: boolean
    originalEntries: {}
    subtitle: any
    DEFAULT_OPTIONS: { classes: string[]; position: { width: number } } = ...
    PARTS: { form: { template: string } } = ...

    Configure a registry of template parts which are supported for this application for partial rendering.

    {}

    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[]

    • get title(): string

      Configure the title of the dialog window.

      Returns string

    Methods

    Protected_getNewEntry

    • _getNewEntry(event: any): object
      Protected

      Provides default data for a new list entry

      Parameters

      • event: any

      Returns object

    Protected_getUpdateData

    • _getUpdateData(): object
      Protected

      Provides update data for saves

      Returns object

    _initializeApplicationOptions

    • _initializeApplicationOptions(
          options: ApplicationConfiguration,
      ): ApplicationConfiguration

      Initialize the configuration for this application. Override the default ID to be unique to this entry selector instance based on document and attribute that is being edited.

      Parameters

      • options: ApplicationConfiguration

        The provided configuration options for the Application

      Returns ApplicationConfiguration

      The final configuration values for the application

    _initializeSelectorOptions

    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>

    Protected_preparePartContext

    • _preparePartContext(
          partId: any,
          context: any,
          options: 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;
          },
      >
      Protected Internal

      Parameters

      • partId: any
      • context: any
      • options: 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;
          },
      >

    _preRender

    • _preRender(context: any, options: any): Promise<void>

      Parameters

      • context: any
      • options: any

      Returns Promise<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