Class EntrySelector

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

Hierarchy (view full)

AbstractListSelector
- EntrySelector

Constructors

constructor

new EntrySelector(options): EntrySelector
Parameters
- options: any
Returns EntrySelector
Overrides AbstractListSelector.constructor
- Defined in module/applications/entry-selector.mjs:25

Properties

dragDropHighlightTimeout

dragDropHighlightTimeout: null | Timeout

entries

entries: any

isBoolean

isBoolean: boolean

isFlag

isFlag: boolean

isFlat

isFlat: boolean

originalEntries

originalEntries: any

subtitle

subtitle: undefined | string

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    classes: string[];
    position: {
        width: number;
    };
} = ...

`Static`PARTS

PARTS: {
    footer: {
        template: string;
    };
    form: {
        template: string;
    };
} = ...

Accessors

attribute

get attribute(): string
Alias the name property

Returns string
Inherited from AbstractListSelector.attribute
- Defined in module/applications/abstract-list-selector.mjs:158

dataCount

get dataCount(): number
Get the data entry length

Returns number
Inherited from AbstractListSelector.dataCount
- Defined in module/applications/abstract-list-selector.mjs:191

dragDropType

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

Returns string
Inherited from AbstractListSelector.dragDropType
- Defined in module/applications/abstract-list-selector.mjs:47

dtypes

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

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

fields

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

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

title

get title(): string
Configure the title of the dialog window.

Returns string
- Defined in module/applications/entry-selector.mjs:75

Methods

`Protected`_getNewEntry

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

`Protected`_getUpdateData

_getUpdateData(): object
Protected
Provides update data for saves

Returns object
Overrides AbstractListSelector._getUpdateData
- Defined in module/applications/entry-selector.mjs:183

_initializeApplicationOptions

_initializeApplicationOptions(options): 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
- Defined in module/applications/entry-selector.mjs:52

_onChangeForm

_onChangeForm(...this, formConfig, event): Promise<void>
Internal
Update internal data snapshot on form change
Parameters
- Rest...this: any
- formConfig: any
- event: any
Returns Promise<void>
Overrides AbstractListSelector._onChangeForm
- Defined in module/applications/entry-selector.mjs:155

`Protected`_onDragOver

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

`Protected`_onDragStart

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

`Protected`_onDrop

_onDrop(event): Promise<void>
Protected
Inject dragged element into its new position
Parameters
- event: DragEvent
  The originating DragEvent
Returns Promise<void>
Inherited from AbstractListSelector._onDrop
- 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;
    isBoolean: boolean;
    isFlat: boolean;
}>
Internal
Returns Promise<{
    buttons: {
        icon: string;
        label: string;
        type: string;
    }[];
    document: any;
    dtypes: string[];
    entries: any;
    fields: string[];
    id: any;
    isBoolean: boolean;
    isFlat: boolean;
}>
Inherit Doc
Async
Overrides AbstractListSelector._prepareContext
- Defined in module/applications/entry-selector.mjs:101

clearDragHighlights

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

`Static`_onAddEntry

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

`Static`_onDeleteEntry

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

`Static`_save

_save(...this, event, form, formData): Promise<void>
Internal
Save the new data back to the document.
Parameters
- Rest...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
Returns Promise<void>
Inherited from AbstractListSelector._save
- Defined in module/applications/abstract-list-selector.mjs:287

Class EntrySelector

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EntrySelector

Properties

dragDropHighlightTimeout

entries

isBoolean

isFlag

isFlat

originalEntries

subtitle

StaticDEFAULT_OPTIONS

StaticPARTS

Accessors

attribute

Returns string

dataCount

Returns number

dragDropType

Returns string

dtypes

Returns string[]

fields

Returns string[]

title

Returns string

Methods

Protected_getNewEntry

Parameters

Returns object

Protected_getUpdateData

Returns object

_initializeApplicationOptions

Parameters

Returns ApplicationConfiguration

_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; isBoolean: boolean; isFlat: boolean; }>

Inherit Doc

Async

clearDragHighlights

Returns void

Static_onAddEntry

Parameters

Returns Promise<void>

Static

Static_onDeleteEntry

Parameters

Returns Promise<void>

Static

Static_save

Parameters

Returns Promise<void>

Settings

On This Page

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Protected`_getNewEntry

`Protected`_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;
isBoolean: boolean;
isFlat: boolean;
}>

`Static`_onAddEntry

`Static`_onDeleteEntry

`Static`_save