Class TextFilter

Base class for filters that require text input.

Hierarchy (View Summary)

BaseFilter
- TextFilter
  - NumberRangeFilter

Index

Constructors

constructor

new TextFilter(compendiumBrowser: CompendiumBrowser): TextFilter
Parameters
- compendiumBrowser: CompendiumBrowser
  The compendium browser this filter is used in.
Returns TextFilter
Inherited from BaseFilter.constructor
- Defined in module/applications/compendium-browser/filters/base.mjs:106

Properties

choices

choices: null | Collection<FilterChoice> = null

A Collection of FilterChoices for this filter.

compendiumBrowser

compendiumBrowser: null | CompendiumBrowser = null

A reference to the CompendiumBrowser this filter is used in.

id

id: string

The ID of this filter used to identify it in its browser's filters.

`Static` `Abstract`indexField

indexField: string = ""

The field this filter checks against its choices. Will also be added to the compendiumIndexFields of the document's CONFIG object.

`Static`inputs

inputs: InputObject[] = []

List of inputs for this filter.

`Static` `Abstract`label

label: string = ""

The label for this filter visible to the user.

`Static`localizeChoices

localizeChoices: boolean = false

Auto-localize choices.

Defaults to false due to pre-translation.

`Static`localizeLabel

localizeLabel: boolean = true

Auto-localize filter label

`Static`localizePrefix

localizePrefix: string = ""

Prefix to add to choices before localization.

`Static`TEMPLATE

TEMPLATE: string = "systems/pf1/templates/apps/compendium-browser/text-filter.hbs"

The handlebars template used to render this filter.

`Static`type

type: string = ""

A convenience property to define a single type this filter applies to.

See

`Static`types

types: string[] = []

The types of document this filter applies to.

See

handledTypes

Accessors

active

get active(): boolean
Whether this filter has any active choices.

Returns boolean
Inherited from baseFilter.BaseFilter.active
- Defined in module/applications/compendium-browser/filters/base.mjs:126

activeChoiceCount

get activeChoiceCount(): number
The number of active choices.

Returns number
Inherited from baseFilter.BaseFilter.activeChoiceCount
- Defined in module/applications/compendium-browser/filters/base.mjs:135

`Static`handledTypes

get handledTypes(): Set<string>
The authoritative Set of types this filter applies to.

Returns Set<string>
Inherited from baseFilter.BaseFilter.handledTypes
- Defined in module/applications/compendium-browser/filters/base.mjs:117

Methods

_parseInput

_parseInput(textInput: string, choice: FilterChoice): string
Parse the input before it is stored in the choice value.
Parameters
- textInput: string
  The text input to parse.
- choice: FilterChoice
  The choice object for custom handle by choice.
Returns string
- The parsed value if any transformation, otherwise the original string.
- Defined in module/applications/compendium-browser/filters/text.mjs:78

activateListeners

activateListeners(html: any): void
Activate event listeners for this filter.
Parameters
- html: any
  The rendered HTML element for this filter only
Returns void
Overrides BaseFilter.activateListeners
- Defined in module/applications/compendium-browser/filters/text.mjs:57

`Abstract`applyFilter

applyFilter(entry: object): boolean
Check whether an entry matches this filter. If the filter is not active, this will always return true.
Parameters
- entry: object
  The entry to check against this filter
Returns boolean
- Whether the entry matches this filter
Inherited from BaseFilter.applyFilter
- Defined in module/applications/compendium-browser/filters/base.mjs:202

getData

getData(): object
Provide data necessary to render this filter. The data object generated by BaseFilter#getData contains the minimum data not only required by the filter itself, but also by the rendering CompendiumBrowser.

Returns object
} The data object for this filter
Inherited from BaseFilter.getData
- Defined in module/applications/compendium-browser/filters/base.mjs:211

hasChoices

hasChoices(number?: number): boolean
Returns whether this filter has more than the given number of choices. Defaults to 1, as a single choice allows for no real filtering.
Parameters
- number: number = 1
  The number of choices to check for
Returns boolean
- Whether this filter has more than the given number of choices
Overrides BaseFilter.hasChoices
- Defined in module/applications/compendium-browser/filters/text.mjs:27

prepareChoices

prepareChoices(): void
Prepare the choices for this filter. This is called after the compendium browser has gathered its entries. By default, this will generate a list of choices from the index field of all entries in the compendium.

Returns void
Overrides BaseFilter.prepareChoices
- Defined in module/applications/compendium-browser/filters/text.mjs:34

registerIndexFields

registerIndexFields(): void
Adds the index fields checked by this filter to the document's CONFIG object, so that CompendiumCollection#getIndex will include them.

Returns void
Inherited from BaseFilter.registerIndexFields
- Defined in module/applications/compendium-browser/filters/base.mjs:143

reset

reset(): void
Reset all choices and controls to their default state (inactive)

Returns void
Overrides BaseFilter.reset
- Defined in module/applications/compendium-browser/filters/text.mjs:49

setup

setup(): Promise<void>
Prepare the filter for use. This step expects the compendium browser to have gathered its entries.

Returns Promise<void>
Inherited from BaseFilter.setup
- Defined in module/applications/compendium-browser/filters/base.mjs:164

Class TextFilter

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TextFilter

Properties

choices

compendiumBrowser

id

Static AbstractindexField

Staticinputs

Static Abstractlabel

StaticlocalizeChoices

StaticlocalizeLabel

StaticlocalizePrefix

StaticTEMPLATE

Statictype

See

Statictypes

See

Accessors

active

Returns boolean

activeChoiceCount

Returns number

StatichandledTypes

Returns Set<string>

Methods

_parseInput

Parameters

Returns string

activateListeners

Parameters

Returns void

AbstractapplyFilter

Parameters

Returns boolean

getData

Returns object

hasChoices

Parameters

Returns boolean

prepareChoices

Returns void

registerIndexFields

Returns void

reset

Returns void

setup

Returns Promise<void>

Settings

On This Page

`Static` `Abstract`indexField

`Static`inputs

`Static` `Abstract`label

`Static`localizeChoices

`Static`localizeLabel

`Static`localizePrefix

`Static`TEMPLATE

`Static`type

`Static`types

`Static`handledTypes

`Abstract`applyFilter