Class FlagSelector

A trait selector variant that reads and stores information into an object with boolean values.

Hierarchy (View Summary)

ActorTraitSelector
- FlagSelector

Index

Constructors

constructor

new FlagSelector(options: any): FlagSelector
Parameters
- options: any
Returns FlagSelector
Overrides ActorTraitSelector.constructor
- Defined in module/applications/flag-selector.mjs:18

Properties

_collator

_collator: Collator = pf1.utils.i18n.sortCollator

Collator for sorting

attributes

attributes: { custom: Set<any>; standard: Set<any> }

The currently stored values for this trait selector

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: { form: { handler: Object } } = ...

`Static`PARTS

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

`Static`SEARCH_INCLUDE_ID

SEARCH_INCLUDE_ID: boolean = true

Include language agnostic ID in search.

Accessors

attribute

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

Returns string
Inherited from <types>.attribute
- Defined in module/applications/trait-selector.mjs:189

promise

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

title

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

Returns string
Inherited from <types>.title
- Defined in module/applications/trait-selector.mjs:178

Methods

_initializeApplicationOptions

_initializeApplicationOptions(options: any): any
Parameters
- options: any
Returns any
Inherited from ActorTraitSelector._initializeApplicationOptions
- Defined in module/applications/trait-selector.mjs:114

_markExternallySourcedChoices

_markExternallySourcedChoices(): void
Internal
Mark Choices from other sources

Returns void
Inherited from ActorTraitSelector._markExternallySourcedChoices
- Defined in module/applications/trait-selector.mjs:250

_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
Inherited from ActorTraitSelector._onActiveCustomInput
- Defined in module/applications/trait-selector.mjs:316

_onChangeForm

_onChangeForm(_formConfig: ApplicationFormConfiguration, _event: 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
Inherited from ActorTraitSelector._onChangeForm
- Defined in module/applications/trait-selector.mjs:448

_onClose

_onClose(options: any): void
Parameters
- options: any
Returns void
Inherited from ActorTraitSelector._onClose
- Defined in module/applications/trait-selector.mjs:282

_onCustomInput

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

`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
Inherited from ActorTraitSelector._onRender
- Defined in module/applications/trait-selector.mjs:217

`Protected`_preparePartContext

_preparePartContext(
    partId: any,
): Promise<
    | undefined
    | {
        buttons?: undefined;
        choices: any;
        cssClass: string;
        custom: any[];
        editable: boolean;
        hasCustom: any;
        hideSearch: boolean;
        search: string;
    }
    | {
        buttons?: undefined;
        choices?: undefined;
        cssClass?: undefined;
        custom?: undefined;
        editable?: undefined;
        hasCustom?: undefined;
        hideSearch?: undefined;
        search?: undefined;
    }
    | {
        buttons: { icon: string; label: string; type: string }[];
        choices?: undefined;
        cssClass?: undefined;
        custom?: undefined;
        editable?: undefined;
        hasCustom?: undefined;
        hideSearch?: undefined;
        search?: undefined;
    },
>
Protected
Parameters
- partId: any
Returns Promise<
    | undefined
    | {
        buttons?: undefined;
        choices: any;
        cssClass: string;
        custom: any[];
        editable: boolean;
        hasCustom: any;
        hideSearch: boolean;
        search: string;
    }
    | {
        buttons?: undefined;
        choices?: undefined;
        cssClass?: undefined;
        custom?: undefined;
        editable?: undefined;
        hasCustom?: undefined;
        hideSearch?: undefined;
        search?: undefined;
    }
    | {
        buttons: { icon: string; label: string; type: string }[];
        choices?: undefined;
        cssClass?: undefined;
        custom?: undefined;
        editable?: undefined;
        hasCustom?: undefined;
        hideSearch?: undefined;
        search?: undefined;
    },
>
Inherit Doc
Inherited from ActorTraitSelector._preparePartContext
- Defined in module/applications/trait-selector.mjs:129

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
Inherited from ActorTraitSelector.splitCustom
- Defined in module/applications/trait-selector.mjs:201

Class FlagSelector

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FlagSelector

Properties

_collator

attributes

StaticDEFAULT_OPTIONS

StaticPARTS

StaticSEARCH_INCLUDE_ID

Accessors

attribute

Returns string

promise

Returns Promise<any>

title

Returns string

Methods

_initializeApplicationOptions

Parameters

Returns any

_markExternallySourcedChoices

Returns void

_onActiveCustomInput

Parameters

Returns void

_onChangeForm

Parameters

Returns void

_onClose

Parameters

Returns void

_onCustomInput

Parameters

Returns void

Protected_onRender

Parameters

Returns void

Protected_preparePartContext

Parameters

Inherit Doc

splitCustom

Parameters

Returns string[]

Settings

On This Page

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Static`SEARCH_INCLUDE_ID

`Protected`_onRender

`Protected`_preparePartContext