Class ActorTraitSelector

A specialized form used to select types.

Hierarchy

any
- ActorTraitSelector

Index

Constructors

constructor

new ActorTraitSelector(options): ActorTraitSelector
Parameters
- options: any
Returns ActorTraitSelector
Overrides HandlebarsApplicationMixin(DocumentSheetV2).constructor
- Defined in module/applications/trait-selector.mjs:50

Properties

_collator

_collator: Collator

Collator for sorting

_searchFilter

_searchFilter: string = ""

Current search filter

_searchIndex

_searchIndex: {
    _id: Prepared;
    _name: Prepared;
    id: string;
}[]

Type declaration

_id: Prepared
_name: Prepared
id: string

attributes

attributes: {
custom: any;
value: any;
}

The currently stored values for this trait selector

Type declaration

custom: any
value: any

`Static` DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    classes: string[];
    form: {
        closeOnSubmit: boolean;
        handler: ((event, form, formData) => Promise<void>);
        submitOnChange: boolean;
        submitOnClose: boolean;
    };
    position: {
        width: number;
    };
    sheetConfig: boolean;
    tag: string;
    window: {
        minimizable: boolean;
        resizable: boolean;
    };
} = ...

Type declaration

classes: string[]
form: {
    closeOnSubmit: boolean;
    handler: ((event, form, formData) => Promise<void>);
    submitOnChange: boolean;
    submitOnClose: boolean;
}
- closeOnSubmit: boolean
- handler: ((event, form, formData) => Promise<void>)
  - - (event, form, formData): Promise<void>
    - Private
      Update the Actor object with new trait data processed from the form
      Parameters
      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>
- submitOnChange: boolean
- submitOnClose: boolean
position: {
width: number;
}
- width: number
sheetConfig: boolean
tag: string
window: {
minimizable: boolean;
resizable: boolean;
}
- minimizable: boolean
- resizable: boolean

`Static` PARTS

PARTS: {
    footer: {
        template: string;
    };
    form: {
        scrollable: string[];
        template: string;
    };
} = ...

Type declaration

footer: {
template: string;
}
- template: string
form: {
scrollable: string[];
template: string;
}
- scrollable: string[]
- template: string

`Static` SEARCH_INCLUDE_ID

SEARCH_INCLUDE_ID: boolean = true

Accessors

attribute

get attribute(): string
Return a reference to the target attribute

Returns string
- Defined in module/applications/trait-selector.mjs:140

title

get title(): string
Configure the title of the trait selector window

Returns string
- Defined in module/applications/trait-selector.mjs:129

Methods

_deleteCustomTag

_deleteCustomTag(event): void
Internal
The event handler for deleting a custom tag.
Parameters
- event: Event
  The originating click event
Returns void
- Defined in module/applications/trait-selector.mjs:255

_onActiveCustomInput

_onActiveCustomInput(event): void
Internal
The event handler for active keystrokes on the input field.
Parameters
- event: Event
  The originating keydown event
Returns void
- Defined in module/applications/trait-selector.mjs:213

_onChangeForm

_onChangeForm(formConfig, event): void
Internal
The event handler for changes to form input elements
Parameters
- formConfig: ApplicationFormConfiguration
  The configuration of the form being changed
- event: Event
  The triggering event
Returns void
- Defined in module/applications/trait-selector.mjs:305

_onCustomInput

_onCustomInput(event): void
Internal
The event handler for custom field input.
Parameters
- event: Event
  The originating input event
Returns void
- Defined in module/applications/trait-selector.mjs:197

`Protected` _onRender

_onRender(context, options): void
Protected
Attach event listeners to the rendered application form.
Parameters
- context: ApplicationRenderContext
  Prepared context data
- options: RenderOptions
  Provided render options
Returns void
- Defined in module/applications/trait-selector.mjs:168

_onSearch

_onSearch(query): void
Internal
Run a search on the provided list of options.
Parameters
- query: string
  The search string
Returns void
- Defined in module/applications/trait-selector.mjs:271

_prepareContext

_prepareContext(): Promise<{
    buttons: {
        icon: string;
        label: string;
        type: string;
    }[];
    choices: any;
    custom: any[];
    hasCustom: any;
    hideSearch: boolean;
    search: string;
}>
Internal
Returns Promise<{
    buttons: {
        icon: string;
        label: string;
        type: string;
    }[];
    choices: any;
    custom: any[];
    hasCustom: any;
    hideSearch: boolean;
    search: string;
}>
Inherit Doc
Async
- Defined in module/applications/trait-selector.mjs:93

splitCustom

splitCustom(value): string[]
Split a given value based on the configured separator
Parameters
- value: string
  The value to split
Returns string[]
The split values, with empty values filtered out
- Defined in module/applications/trait-selector.mjs:152

`Static` `Private` _updateDocument

_updateDocument(event, form, formData): Promise<void>
Private
Update the Actor object with new trait data processed from the form
Parameters
- 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>
- Defined in module/applications/trait-selector.mjs:336

Class ActorTraitSelector

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: any

Returns ActorTraitSelector

Properties

_collator

_searchFilter

_searchIndex

Type declaration

_id: Prepared

_name: Prepared

id: string

attributes

Type declaration

custom: any

value: any

Static DEFAULT_OPTIONS

Type declaration

classes: string[]

form: { closeOnSubmit: boolean; handler: ((event, form, formData) => Promise<void>); submitOnChange: boolean; submitOnClose: boolean; }

closeOnSubmit: boolean

handler: ((event, form, formData) => Promise<void>)

Parameters

event: SubmitEvent

form: HTMLFormElement

formData: FormDataExtended

Returns Promise<void>

submitOnChange: boolean

submitOnClose: boolean

position: { width: number; }

width: number

sheetConfig: boolean

tag: string

window: { minimizable: boolean; resizable: boolean; }

minimizable: boolean

resizable: boolean

Static PARTS

Type declaration

footer: { template: string; }

template: string

form: { scrollable: string[]; template: string; }

scrollable: string[]

template: string

Static SEARCH_INCLUDE_ID

Accessors

attribute

Returns string

title

Returns string

Methods

_deleteCustomTag

Parameters

event: Event

Returns void

_onActiveCustomInput

Parameters

event: Event

Returns void

_onChangeForm

Parameters

formConfig: ApplicationFormConfiguration

event: Event

Returns void

_onCustomInput

Parameters

event: Event

Returns void

Protected _onRender

Parameters

context: ApplicationRenderContext

options: RenderOptions

Returns void

`Static` DEFAULT_OPTIONS

form: {
closeOnSubmit: boolean;
handler: ((event, form, formData) => Promise<void>);
submitOnChange: boolean;
submitOnClose: boolean;
}

position: {
width: number;
}

window: {
minimizable: boolean;
resizable: boolean;
}

`Static` PARTS

footer: {
template: string;
}

form: {
scrollable: string[];
template: string;
}

`Static` SEARCH_INCLUDE_ID

`Protected` _onRender

Returns Promise<{
buttons: {
icon: string;
label: string;
type: string;
}[];
choices: any;
custom: any[];
hasCustom: any;
hideSearch: boolean;
search: string;
}>

`Static` `Private` _updateDocument