@serenity-is/corelib / BaseEditorFiltering

Class: BaseEditorFiltering<TEditor>

Type parameters

Name	Type
TEditor	extends Widget<any>

Hierarchy

• BaseFiltering

  ↳ BaseEditorFiltering

  ↳↳ DateFiltering

  ↳↳ DateTimeFiltering

  ↳↳ DecimalFiltering

  ↳↳ EditorFiltering

  ↳↳ EnumFiltering

  ↳↳ IntegerFiltering

  ↳↳ LookupFiltering

  ↳↳ ServiceLookupFiltering

Table of contents

Constructors

• constructor

Properties

• editor
• editorTypeRef

Methods

• appendComparisonOperators
• appendNullableOperators
• argumentNull
• createEditor
• displayText
• getCriteria
• getCriteriaField
• getEditorOptions
• getEditorText
• getEditorValue
• getOperators
• getTitle
• get_container
• get_field
• get_operator
• initQuickFilter
• isNullable
• loadState
• operatorFormat
• saveState
• set_container
• set_field
• set_operator
• useEditor
• useIdField
• validateEditorValue

Constructors

constructor

• new BaseEditorFiltering<TEditor>(editorTypeRef): BaseEditorFiltering<TEditor>

Type parameters

Name	Type
TEditor	extends Widget<any>

Parameters

Name	Type
editorTypeRef	any

Returns

BaseEditorFiltering<TEditor>

Overrides

BaseFiltering.constructor

Defined in

src/ui/filtering/filtering.ts:304

Properties

editor

• Protected editor: TEditor

Defined in

src/ui/filtering/filtering.ts:321

---

editorTypeRef

• editorTypeRef: any

Defined in

src/ui/filtering/filtering.ts:304

Methods

appendComparisonOperators

▸ appendComparisonOperators(list): FilterOperator[]

Parameters

Name	Type
list	FilterOperator[]

Returns

FilterOperator[]

Inherited from

BaseFiltering.appendComparisonOperators

Defined in

src/ui/filtering/filtering.ts:94

---

appendNullableOperators

▸ appendNullableOperators(list): FilterOperator[]

Parameters

Name	Type
list	FilterOperator[]

Returns

FilterOperator[]

Inherited from

BaseFiltering.appendNullableOperators

Defined in

src/ui/filtering/filtering.ts:85

---

argumentNull

▸ argumentNull(): Error

Returns

Error

Inherited from

BaseFiltering.argumentNull

Defined in

src/ui/filtering/filtering.ts:240

---

createEditor

▸ createEditor(): void

Returns

void

Overrides

BaseFiltering.createEditor

Defined in

src/ui/filtering/filtering.ts:323

---

displayText

▸ displayText(op, values?): string

Parameters

Name	Type
op	FilterOperator
values?	any[]

Returns

string

Inherited from

BaseFiltering.displayText

Defined in

src/ui/filtering/filtering.ts:141

---

getCriteria

▸ getCriteria(): CriteriaWithText

Returns

CriteriaWithText

Inherited from

BaseFiltering.getCriteria

Defined in

src/ui/filtering/filtering.ts:157

---

getCriteriaField

▸ getCriteriaField(): string

Returns

string

Overrides

BaseFiltering.getCriteriaField

Defined in

src/ui/filtering/filtering.ts:341

---

getEditorOptions

▸ getEditorOptions(): any

Returns

any

Defined in

src/ui/filtering/filtering.ts:351

---

getEditorText

▸ getEditorText(): string

Returns

string

Inherited from

BaseFiltering.getEditorText

Defined in

src/ui/filtering/filtering.ts:273

---

getEditorValue

▸ getEditorValue(): any

Returns

any

Overrides

BaseFiltering.getEditorValue

Defined in

src/ui/filtering/filtering.ts:379

---

getOperators

▸ getOperators(): FilterOperator[]

Returns

FilterOperator[]

Inherited from

BaseFiltering.getOperators

Defined in

src/ui/filtering/filtering.ts:83

---

getTitle

▸ getTitle(field): string

Parameters

Name	Type
field	PropertyItem

Returns

string

Inherited from

BaseFiltering.getTitle

Defined in

src/ui/filtering/filtering.ts:137

---

get_container

▸ get_container(): HTMLElement

Returns

HTMLElement

Inherited from

BaseFiltering.get_container

Defined in

src/ui/filtering/filtering.ts:65

---

get_field

▸ get_field(): PropertyItem

Returns

PropertyItem

Inherited from

BaseFiltering.get_field

Defined in

src/ui/filtering/filtering.ts:55

---

get_operator

▸ get_operator(): FilterOperator

Returns

FilterOperator

Inherited from

BaseFiltering.get_operator

Defined in

src/ui/filtering/filtering.ts:75

---

initQuickFilter

▸ initQuickFilter(filter): void

Parameters

Name	Type
filter	QuickFilter<Widget<any>, any>

Returns

void

Overrides

BaseFiltering.initQuickFilter

Defined in

src/ui/filtering/filtering.ts:392

---

isNullable

▸ isNullable(): boolean

Returns

boolean

Inherited from

BaseFiltering.isNullable

Defined in

src/ui/filtering/filtering.ts:104

---

loadState

▸ loadState(state): void

Parameters

Name	Type
state	any

Returns

void

Overrides

BaseFiltering.loadState

Defined in

src/ui/filtering/filtering.ts:358

---

operatorFormat

▸ operatorFormat(op): string

Parameters

Name	Type
op	FilterOperator

Returns

string

Inherited from

BaseFiltering.operatorFormat

Defined in

src/ui/filtering/filtering.ts:133

---

saveState

▸ saveState(): any

Returns

any

Overrides

BaseFiltering.saveState

Defined in

src/ui/filtering/filtering.ts:371

---

set_container

▸ set_container(value): void

Parameters

Name	Type
value	HTMLElement

Returns

void

Inherited from

BaseFiltering.set_container

Defined in

src/ui/filtering/filtering.ts:69

---

set_field

▸ set_field(value): void

Parameters

Name	Type
value	PropertyItem

Returns

void

Inherited from

BaseFiltering.set_field

Defined in

src/ui/filtering/filtering.ts:59

---

set_operator

▸ set_operator(value): void

Parameters

Name	Type
value	FilterOperator

Returns

void

Inherited from

BaseFiltering.set_operator

Defined in

src/ui/filtering/filtering.ts:79

---

useEditor

▸ useEditor(): boolean

Returns

boolean

Defined in

src/ui/filtering/filtering.ts:308

---

useIdField

▸ useIdField(): boolean

Returns

boolean

Defined in

src/ui/filtering/filtering.ts:337

---

validateEditorValue

▸ validateEditorValue(value): string

Parameters

Name	Type
value	string

Returns

string

Inherited from

BaseFiltering.validateEditorValue

Defined in

src/ui/filtering/filtering.ts:244