Class TraitSelector

A specialized form used to select types.

Hierarchy (View Summary)

HandlebarsApplication<this> & DocumentSheetV2<
    any,
    RenderContext<any>,
    Configuration<any>,
    RenderOptions,
    this,
>
- TraitSelector
  - FlagSelector

Index

Constructors

constructor

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

Properties

`Internal`_collator

_collator: Collator = pf1.utils.i18n.sortCollator

Collator for sorting

document

document: ActorPF | ItemPF

trait

trait: any

Currently stored values

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: { deleteCustom: Object };
    classes: string[];
    form: { closeOnSubmit: boolean; handler: Object; submitOnChange: boolean };
    id: string;
    position: { width: number };
    sheetConfig: boolean;
    tag: string;
    window: { icon: string; minimizable: boolean; resizable: boolean };
} = ...

`Static`PARTS

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

`Static`SEARCH_INCLUDE_ID

SEARCH_INCLUDE_ID: boolean = true

Include language agnostic ID in search.

Accessors

path

get path(): string
Data path to the trait

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

promise

get promise(): Promise<any>
Returns Promise<any>
- Defined in module/applications/trait-selector.mjs:13

title

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

Returns string
Overrides HandlebarsApplicationMixin(DocumentSheetV2).title
- Defined in module/applications/trait-selector.mjs:164

Methods

_initialize

_initialize(): void
Returns void
- Defined in module/applications/trait-selector.mjs:91

_initializeApplicationOptions

_initializeApplicationOptions(options: any): any
Parameters
- options: any
Returns any
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._initializeApplicationOptions
- Defined in module/applications/trait-selector.mjs:79

_markExternallySourcedChoices

_markExternallySourcedChoices(): void
Internal
Mark Choices from other sources

Returns void
- Defined in module/applications/trait-selector.mjs:236

_onActiveCustomInput

_onActiveCustomInput(event: 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:325

`Protected`_onChangeForm

_onChangeForm(formConfig: object, event: Event): void
Protected
Parameters
- formConfig: object
- event: Event
Returns void
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._onChangeForm
- Defined in module/applications/trait-selector.mjs:306

_onClose

_onClose(options: any): void
Parameters
- options: any
Returns void
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._onClose
- Defined in module/applications/trait-selector.mjs:276

_onCustomInput

_onCustomInput(event: 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:294

`Protected`_onRender

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

_preClose

_preClose(options: any): Promise<void>
Parameters
- options: any
Returns Promise<void>
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._preClose
- Defined in module/applications/trait-selector.mjs:454

`Protected`_preparePartContext

_preparePartContext(
    partId: any,
): Promise<
    | undefined
    | {
        choices: any;
        cssClass: string;
        custom: any[];
        editable: boolean;
        hasCustom: any;
        hideSearch: boolean;
        search: string;
    },
>
Protected
Parameters
- partId: any
Returns Promise<
    | undefined
    | {
        choices: any;
        cssClass: string;
        custom: any[];
        editable: boolean;
        hasCustom: any;
        hideSearch: boolean;
        search: string;
    },
>
Inherit Doc
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._preparePartContext
- Defined in module/applications/trait-selector.mjs:127

splitCustom

splitCustom(value: string): 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:187

Class TraitSelector

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TraitSelector

Properties

Internal_collator

document

trait

StaticDEFAULT_OPTIONS

StaticPARTS

StaticSEARCH_INCLUDE_ID

Accessors

path

Returns string

promise

Returns Promise<any>

title

Returns string

Methods

_initialize

Returns void

_initializeApplicationOptions

Parameters

Returns any

_markExternallySourcedChoices

Returns void

_onActiveCustomInput

Parameters

Returns void

Protected_onChangeForm

Parameters

Returns void

_onClose

Parameters

Returns void

_onCustomInput

Parameters

Returns void

Protected_onRender

Parameters

Returns void

_preClose

Parameters

Returns Promise<void>

Protected_preparePartContext

Parameters

Returns Promise< | undefined | { choices: any; cssClass: string; custom: any[]; editable: boolean; hasCustom: any; hideSearch: boolean; search: string; },>

Inherit Doc

splitCustom

Parameters

Returns string[]

Settings

On This Page

`Internal`_collator

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Static`SEARCH_INCLUDE_ID

`Protected`_onChangeForm

`Protected`_onRender

`Protected`_preparePartContext

Returns Promise<
| undefined
| {
choices: any;
cssClass: string;
custom: any[];
editable: boolean;
hasCustom: any;
hideSearch: boolean;
search: string;
},
>