@serenity-is/corelib / FilterPanel

Class: FilterPanel<P>

Type parameters

Name	Type
P

Hierarchy

• FilterWidgetBase<P>

  ↳ FilterPanel

Table of contents

Constructors

• constructor

Properties

• domNode
• idPrefix
• options
• uniqueName
• typeInfo

Accessors

• element
• props

Methods

• addButtonClick
• addCssClass
• addEmptyRow
• addValidationRule
• andOrClick
• byId
• change
• changeSelect2
• deleteRowClick
• destroy
• filterStoreChanged
• findById
• findEmptyRow
• getCssClass
• getCustomAttribute
• getFieldElement
• getFieldFor
• getFilteringFor
• getGridField
• getTemplate
• get_hasErrors
• get_showInitialLine
• get_showSearchButton
• get_store
• get_updateStoreOnReset
• init
• initButtons
• internalInit
• internalRenderContents
• leftRightParenClick
• onRowFieldChange
• onRowOperatorChange
• populateOperatorList
• removeFiltering
• render
• renderContents
• resetButtonClick
• rowFieldChange
• rowOperatorChange
• search
• searchButtonClick
• set_showInitialLine
• set_showSearchButton
• set_store
• set_updateStoreOnReset
• syncOrAsyncThen
• updateButtons
• updateParens
• updateRowsFromStore
• useIdPrefix
• create
• createDefaultElement
• getWidgetName

Constructors

constructor

• new FilterPanel<P>(props): FilterPanel<P>

Type parameters

Name	Type
P

Parameters

Name	Type
props	WidgetProps<P>

Returns

FilterPanel<P>

Overrides

FilterWidgetBase.constructor

Defined in

src/ui/filtering/filterpanel.ts:73

Properties

domNode

• Readonly domNode: HTMLElement

Inherited from

FilterWidgetBase.domNode

Defined in

src/ui/widgets/widget.ts:18

---

idPrefix

• Readonly idPrefix: string

Inherited from

FilterWidgetBase.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

FilterWidgetBase.options

Defined in

src/ui/widgets/widget.ts:15

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

FilterWidgetBase.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

typeInfo

▪ Static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

FilterWidgetBase.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

FilterWidgetBase.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

FilterWidgetBase.props

Defined in

src/ui/widgets/widget.ts:182

Methods

addButtonClick

▸ addButtonClick(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:255

---

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

FilterWidgetBase.addCssClass

Defined in

src/ui/widgets/widget.ts:71

---

addEmptyRow

▸ addEmptyRow(popupField): HTMLElement

Parameters

Name	Type
popupField	boolean

Returns

HTMLElement

Defined in

src/ui/filtering/filterpanel.ts:294

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

Name	Type
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string
uniqueName?	string

Returns

void

Inherited from

FilterWidgetBase.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

▸ addValidationRule(uniqueName, rule): void

Parameters

Name	Type
uniqueName	string
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string

Returns

void

Inherited from

FilterWidgetBase.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

andOrClick

▸ andOrClick(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:491

---

byId

▸ byId<TElement>(id): Fluent<TElement>

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

Fluent<TElement>

Inherited from

FilterWidgetBase.byId

Defined in

src/ui/widgets/templatedwidget.ts:8

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

FilterWidgetBase.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

FilterWidgetBase.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

deleteRowClick

▸ deleteRowClick(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:471

---

destroy

▸ destroy(): void

Returns

void

Inherited from

FilterWidgetBase.destroy

Defined in

src/ui/filtering/filterwidgetbase.ts:20

---

filterStoreChanged

▸ filterStoreChanged(): void

Returns

void

Overrides

FilterWidgetBase.filterStoreChanged

Defined in

src/ui/filtering/filterpanel.ts:97

---

findById

▸ findById<TElement>(id): TElement

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

TElement

Inherited from

FilterWidgetBase.findById

Defined in

src/ui/widgets/templatedwidget.ts:12

---

findEmptyRow

▸ findEmptyRow(): HTMLElement

Returns

HTMLElement

Defined in

src/ui/filtering/filterpanel.ts:277

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

FilterWidgetBase.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCustomAttribute

▸ getCustomAttribute<TAttr>(attrType, inherit?): TAttr

Type parameters

Name
TAttr

Parameters

Name	Type	Default value
attrType	(...args: any[]) => TAttr	undefined
inherit	boolean	true

Returns

TAttr

Inherited from

FilterWidgetBase.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

FilterWidgetBase.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getFieldFor

▸ getFieldFor(row): PropertyItem

Parameters

Name	Type
row	HTMLElement

Returns

PropertyItem

Defined in

src/ui/filtering/filterpanel.ts:395

---

getFilteringFor

▸ getFilteringFor(row): IFiltering

Parameters

Name	Type
row	HTMLElement

Returns

IFiltering

Defined in

src/ui/filtering/filterpanel.ts:408

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

FilterWidgetBase.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getTemplate

▸ getTemplate(): string

Returns

string

Overrides

FilterWidgetBase.getTemplate

Defined in

src/ui/filtering/filterpanel.ts:167

---

get_hasErrors

▸ get_hasErrors(): boolean

Returns

boolean

Defined in

src/ui/filtering/filterpanel.ts:195

---

get_showInitialLine

▸ get_showInitialLine(): boolean

Returns

boolean

Defined in

src/ui/filtering/filterpanel.ts:84

---

get_showSearchButton

▸ get_showSearchButton(): boolean

Returns

boolean

Defined in

src/ui/filtering/filterpanel.ts:144

---

get_store

▸ get_store(): FilterStore

Returns

FilterStore

Inherited from

FilterWidgetBase.get_store

Defined in

src/ui/filtering/filterwidgetbase.ts:34

---

get_updateStoreOnReset

▸ get_updateStoreOnReset(): boolean

Returns

boolean

Defined in

src/ui/filtering/filterpanel.ts:157

---

init

▸ init(): this

Returns

this

Inherited from

FilterWidgetBase.init

Defined in

src/ui/widgets/widget.ts:146

---

initButtons

▸ initButtons(): void

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:179

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

FilterWidgetBase.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

FilterWidgetBase.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

leftRightParenClick

▸ leftRightParenClick(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:499

---

onRowFieldChange

▸ onRowFieldChange(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:360

---

onRowOperatorChange

▸ onRowOperatorChange(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:431

---

populateOperatorList

▸ populateOperatorList(row): void

Parameters

Name	Type
row	HTMLElement

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:380

---

removeFiltering

▸ removeFiltering(row): void

Parameters

Name	Type
row	HTMLElement

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:375

---

render

▸ render(): any

Returns the main element for this widget or the document fragment. As widgets may get their elements from props unlike regular JSX widgets, this method should not be overridden. Override renderContents() instead.

Returns

any

Inherited from

FilterWidgetBase.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): void

Returns

void

Inherited from

FilterWidgetBase.renderContents

Defined in

src/ui/widgets/templatedwidget.ts:20

---

resetButtonClick

▸ resetButtonClick(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:260

---

rowFieldChange

▸ rowFieldChange(row): void

Parameters

Name	Type
row	HTMLElement

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:366

---

rowOperatorChange

▸ rowOperatorChange(row): void

Parameters

Name	Type
row	HTMLElement

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:442

---

search

▸ search(): void

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:199

---

searchButtonClick

▸ searchButtonClick(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:190

---

set_showInitialLine

▸ set_showInitialLine(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:88

---

set_showSearchButton

▸ set_showSearchButton(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:148

---

set_store

▸ set_store(value): void

Parameters

Name	Type
value	FilterStore

Returns

void

Inherited from

FilterWidgetBase.set_store

Defined in

src/ui/filtering/filterwidgetbase.ts:38

---

set_updateStoreOnReset

▸ set_updateStoreOnReset(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:161

---

syncOrAsyncThen

▸ syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void

Type parameters

Name
T

Parameters

Name	Type
syncMethod	() => T
asyncMethod	() => PromiseLike<T>
then	(v: T) => void

Returns

void

Inherited from

FilterWidgetBase.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

updateButtons

▸ updateButtons(): void

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:484

---

updateParens

▸ updateParens(): void

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:505

---

updateRowsFromStore

▸ updateRowsFromStore(): void

Returns

void

Defined in

src/ui/filtering/filterpanel.ts:102

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

FilterWidgetBase.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

create

▸ create<TWidget, P>(params): TWidget

Type parameters

Name	Type
TWidget	extends Widget<P>
P	P

Parameters

Name	Type
params	CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

FilterWidgetBase.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

FilterWidgetBase.createDefaultElement

Defined in

src/ui/widgets/widget.ts:60

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

FilterWidgetBase.getWidgetName

Defined in

src/ui/widgets/widget.ts:95