@serenity-is/corelib / EditorFiltering
Class: EditorFiltering
Hierarchy
BaseEditorFiltering
<Widget
<any
>>↳
EditorFiltering
Table of contents
Constructors
Properties
Accessors
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 EditorFiltering(props?
): EditorFiltering
Parameters
Name | Type |
---|---|
props |
Object |
props.editorType? |
string |
props.useLike? |
boolean |
props.useRelative? |
boolean |
Returns
Overrides
BaseEditorFiltering.constructor
Defined in
src/ui/filtering/filtering.ts:502
Properties
editor
• Protected
editor: Widget
<any
>
Inherited from
Defined in
src/ui/filtering/filtering.ts:321
editorTypeRef
• editorTypeRef: any
Inherited from
BaseEditorFiltering.editorTypeRef
Defined in
src/ui/filtering/filtering.ts:304
props
• Readonly
props: Object
= {}
Type declaration
Name | Type |
---|---|
editorType? |
string |
useLike? |
boolean |
useRelative? |
boolean |
Defined in
src/ui/filtering/filtering.ts:502
Accessors
editorType
• get
editorType(): string
Returns
string
Defined in
src/ui/filtering/filtering.ts:507
• set
editorType(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/filtering/filtering.ts:508
useLike
• get
useLike(): boolean
Returns
boolean
Defined in
src/ui/filtering/filtering.ts:513
• set
useLike(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Defined in
src/ui/filtering/filtering.ts:514
useRelative
• get
useRelative(): boolean
Returns
boolean
Defined in
src/ui/filtering/filtering.ts:510
• set
useRelative(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Defined in
src/ui/filtering/filtering.ts:511
Methods
appendComparisonOperators
▸ appendComparisonOperators(list
): FilterOperator
[]
Parameters
Name | Type |
---|---|
list |
FilterOperator [] |
Returns
Inherited from
BaseEditorFiltering.appendComparisonOperators
Defined in
src/ui/filtering/filtering.ts:94
appendNullableOperators
▸ appendNullableOperators(list
): FilterOperator
[]
Parameters
Name | Type |
---|---|
list |
FilterOperator [] |
Returns
Inherited from
BaseEditorFiltering.appendNullableOperators
Defined in
src/ui/filtering/filtering.ts:85
argumentNull
▸ argumentNull(): Error
Returns
Error
Inherited from
BaseEditorFiltering.argumentNull
Defined in
src/ui/filtering/filtering.ts:240
createEditor
▸ createEditor(): void
Returns
void
Overrides
BaseEditorFiltering.createEditor
Defined in
src/ui/filtering/filtering.ts:560
displayText
▸ displayText(op
, values?
): string
Parameters
Name | Type |
---|---|
op |
FilterOperator |
values? |
any [] |
Returns
string
Inherited from
BaseEditorFiltering.displayText
Defined in
src/ui/filtering/filtering.ts:141
getCriteria
▸ getCriteria(): CriteriaWithText
Returns
Inherited from
BaseEditorFiltering.getCriteria
Defined in
src/ui/filtering/filtering.ts:157
getCriteriaField
▸ getCriteriaField(): string
Returns
string
Inherited from
BaseEditorFiltering.getCriteriaField
Defined in
src/ui/filtering/filtering.ts:341
getEditorOptions
▸ getEditorOptions(): any
Returns
any
Overrides
BaseEditorFiltering.getEditorOptions
Defined in
src/ui/filtering/filtering.ts:551
getEditorText
▸ getEditorText(): string
Returns
string
Inherited from
BaseEditorFiltering.getEditorText
Defined in
src/ui/filtering/filtering.ts:273
getEditorValue
▸ getEditorValue(): any
Returns
any
Inherited from
BaseEditorFiltering.getEditorValue
Defined in
src/ui/filtering/filtering.ts:379
getOperators
▸ getOperators(): FilterOperator
[]
Returns
Overrides
BaseEditorFiltering.getOperators
Defined in
src/ui/filtering/filtering.ts:516
getTitle
▸ getTitle(field
): string
Parameters
Name | Type |
---|---|
field |
PropertyItem |
Returns
string
Inherited from
Defined in
src/ui/filtering/filtering.ts:137
get_container
▸ get_container(): HTMLElement
Returns
HTMLElement
Inherited from
BaseEditorFiltering.get_container
Defined in
src/ui/filtering/filtering.ts:65
get_field
▸ get_field(): PropertyItem
Returns
Inherited from
Defined in
src/ui/filtering/filtering.ts:55
get_operator
▸ get_operator(): FilterOperator
Returns
Inherited from
BaseEditorFiltering.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
BaseEditorFiltering.initQuickFilter
Defined in
src/ui/filtering/filtering.ts:579
isNullable
▸ isNullable(): boolean
Returns
boolean
Inherited from
BaseEditorFiltering.isNullable
Defined in
src/ui/filtering/filtering.ts:104
loadState
▸ loadState(state
): void
Parameters
Name | Type |
---|---|
state |
any |
Returns
void
Inherited from
Defined in
src/ui/filtering/filtering.ts:358
operatorFormat
▸ operatorFormat(op
): string
Parameters
Name | Type |
---|---|
op |
FilterOperator |
Returns
string
Inherited from
BaseEditorFiltering.operatorFormat
Defined in
src/ui/filtering/filtering.ts:133
saveState
▸ saveState(): any
Returns
any
Inherited from
Defined in
src/ui/filtering/filtering.ts:371
set_container
▸ set_container(value
): void
Parameters
Name | Type |
---|---|
value |
HTMLElement |
Returns
void
Inherited from
BaseEditorFiltering.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
Defined in
src/ui/filtering/filtering.ts:59
set_operator
▸ set_operator(value
): void
Parameters
Name | Type |
---|---|
value |
FilterOperator |
Returns
void
Inherited from
BaseEditorFiltering.set_operator
Defined in
src/ui/filtering/filtering.ts:79
useEditor
▸ useEditor(): boolean
Returns
boolean
Overrides
Defined in
src/ui/filtering/filtering.ts:539
useIdField
▸ useIdField(): boolean
Returns
boolean
Overrides
BaseEditorFiltering.useIdField
Defined in
src/ui/filtering/filtering.ts:575
validateEditorValue
▸ validateEditorValue(value
): string
Parameters
Name | Type |
---|---|
value |
string |
Returns
string
Inherited from
BaseEditorFiltering.validateEditorValue