@serenity-is/corelib / LookupEditorBase

Class: LookupEditorBase<P, TItem>

Type parameters

Name Type
P extends LookupEditorOptions
TItem TItem

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new LookupEditorBase<P, TItem>(props): LookupEditorBase<P, TItem>

Type parameters

Name Type
P extends LookupEditorOptions
TItem TItem

Parameters

Name Type
props EditorProps<P>

Returns

LookupEditorBase<P, TItem>

Overrides

ComboboxEditor.constructor

Defined in

src/ui/editors/lookupeditor.ts:18

Properties

Protected cascadeLink: CascadedWidgetLink<Widget<any>>

Inherited from

ComboboxEditor.cascadeLink

Defined in

src/ui/editors/comboboxeditor.ts:572


domNode

Readonly domNode: HTMLInputElement

Inherited from

ComboboxEditor.domNode

Defined in

src/ui/editors/comboboxeditor.ts:44


idPrefix

Readonly idPrefix: string

Inherited from

ComboboxEditor.idPrefix

Defined in

src/ui/widgets/widget.ts:17


lastCreateTerm

Protected lastCreateTerm: string

Inherited from

ComboboxEditor.lastCreateTerm

Defined in

src/ui/editors/comboboxeditor.ts:49


lookup

Protected lookup: Lookup<TItem>

Defined in

src/ui/editors/lookupeditor.ts:59


onInitNewEntity

onInitNewEntity: (entity: TItem) => void

Type declaration

▸ (entity): void

Parameters
Name Type
entity TItem
Returns

void

Inherited from

ComboboxEditor.onInitNewEntity

Defined in

src/ui/editors/comboboxeditor.ts:740


openDialogAsPanel

openDialogAsPanel: boolean

Inherited from

ComboboxEditor.openDialogAsPanel

Defined in

src/ui/editors/comboboxeditor.ts:846


options

Protected Readonly options: WidgetProps<P>

Inherited from

ComboboxEditor.options

Defined in

src/ui/widgets/widget.ts:15


uniqueName

Protected Readonly uniqueName: string

Inherited from

ComboboxEditor.uniqueName

Defined in

src/ui/widgets/widget.ts:16


typeInfo

Static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

ComboboxEditor.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

cascadeField

get cascadeField(): string

Returns

string

Inherited from

ComboboxEditor.cascadeField

Defined in

src/ui/editors/comboboxeditor.ts:616

set cascadeField(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

ComboboxEditor.cascadeField

Defined in

src/ui/editors/comboboxeditor.ts:624


cascadeFrom

get cascadeFrom(): string

Returns

string

Inherited from

ComboboxEditor.cascadeFrom

Defined in

src/ui/editors/comboboxeditor.ts:597

set cascadeFrom(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

ComboboxEditor.cascadeFrom

Defined in

src/ui/editors/comboboxeditor.ts:608


cascadeValue

get cascadeValue(): any

Returns

any

Inherited from

ComboboxEditor.cascadeValue

Defined in

src/ui/editors/comboboxeditor.ts:632

set cascadeValue(value): void

Parameters

Name Type
value any

Returns

void

Inherited from

ComboboxEditor.cascadeValue

Defined in

src/ui/editors/comboboxeditor.ts:644


element

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

ComboboxEditor.element

Defined in

src/ui/widgets/widget.ts:67


filterField

get filterField(): string

Returns

string

Inherited from

ComboboxEditor.filterField

Defined in

src/ui/editors/comboboxeditor.ts:652

set filterField(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

ComboboxEditor.filterField

Defined in

src/ui/editors/comboboxeditor.ts:660


filterValue

get filterValue(): any

Returns

any

Inherited from

ComboboxEditor.filterValue

Defined in

src/ui/editors/comboboxeditor.ts:668

set filterValue(value): void

Parameters

Name Type
value any

Returns

void

Inherited from

ComboboxEditor.filterValue

Defined in

src/ui/editors/comboboxeditor.ts:680


itemById

get itemById(): Object

Returns

Object

Inherited from

ComboboxEditor.itemById

Defined in

src/ui/editors/comboboxeditor.ts:259

set itemById(value): void

Parameters

Name Type
value Object

Returns

void

Inherited from

ComboboxEditor.itemById

Defined in

src/ui/editors/comboboxeditor.ts:266


items

get items(): ComboboxItem<TItem>[]

Returns

ComboboxItem<TItem>[]

Inherited from

ComboboxEditor.items

Defined in

src/ui/editors/comboboxeditor.ts:242

set items(value): void

Parameters

Name Type
value ComboboxItem<TItem>[]

Returns

void

Inherited from

ComboboxEditor.items

Defined in

src/ui/editors/comboboxeditor.ts:249


props

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

ComboboxEditor.props

Defined in

src/ui/widgets/widget.ts:182


readOnly

get readOnly(): boolean

Returns

boolean

Inherited from

ComboboxEditor.readOnly

Defined in

src/ui/editors/comboboxeditor.ts:542

set readOnly(value): void

Parameters

Name Type
value boolean

Returns

void

Inherited from

ComboboxEditor.readOnly

Defined in

src/ui/editors/comboboxeditor.ts:564


selectedItem

get selectedItem(): TItem

Returns

TItem

Inherited from

ComboboxEditor.selectedItem

Defined in

src/ui/editors/comboboxeditor.ts:485


selectedItems

get selectedItems(): TItem[]

Returns

TItem[]

Inherited from

ComboboxEditor.selectedItems

Defined in

src/ui/editors/comboboxeditor.ts:495


text

get text(): string

Returns

string

Inherited from

ComboboxEditor.text

Defined in

src/ui/editors/comboboxeditor.ts:534


value

get value(): string

Returns

string

Inherited from

ComboboxEditor.value

Defined in

src/ui/editors/comboboxeditor.ts:466

set value(v): void

Parameters

Name Type
v string

Returns

void

Inherited from

ComboboxEditor.value

Defined in

src/ui/editors/comboboxeditor.ts:481


values

get values(): string[]

Returns

string[]

Inherited from

ComboboxEditor.values

Defined in

src/ui/editors/comboboxeditor.ts:514

set values(value): void

Parameters

Name Type
value string[]

Returns

void

Inherited from

ComboboxEditor.values

Defined in

src/ui/editors/comboboxeditor.ts:522

Methods

abortPendingQuery

abortPendingQuery(): void

Returns

void

Inherited from

ComboboxEditor.abortPendingQuery

Defined in

src/ui/editors/comboboxeditor.ts:157


addCssClass

addCssClass(): void

Returns

void

Inherited from

ComboboxEditor.addCssClass

Defined in

src/ui/widgets/widget.ts:71


addInplaceCreate

addInplaceCreate(addTitle, editTitle): void

Parameters

Name Type
addTitle string
editTitle string

Returns

void

Inherited from

ComboboxEditor.addInplaceCreate

Defined in

src/ui/editors/comboboxeditor.ts:298


addItem

addItem(item): void

Parameters

Name Type
item ComboboxItem<TItem>

Returns

void

Inherited from

ComboboxEditor.addItem

Defined in

src/ui/editors/comboboxeditor.ts:281


addOption

addOption(key, text, source?, disabled?): void

Parameters

Name Type
key string
text string
source? any
disabled? boolean

Returns

void

Inherited from

ComboboxEditor.addOption

Defined in

src/ui/editors/comboboxeditor.ts:289


addValidationRule

addValidationRule(rule, uniqueName?): void

Parameters

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

Returns

void

Inherited from

ComboboxEditor.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

ComboboxEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:100


allowClear

allowClear(): boolean

Returns

boolean

Inherited from

ComboboxEditor.allowClear

Defined in

src/ui/editors/comboboxeditor.ts:148


asyncSearch

asyncSearch(query): Promise<ComboboxSearchResult<TItem>>

Parameters

Name Type
query ComboboxSearchQuery

Returns

Promise<ComboboxSearchResult<TItem>>

Overrides

ComboboxEditor.asyncSearch

Defined in

src/ui/editors/lookupeditor.ts:109


cascadeItems

cascadeItems(items): TItem[]

Parameters

Name Type
items TItem[]

Returns

TItem[]

Inherited from

ComboboxEditor.cascadeItems

Defined in

src/ui/editors/comboboxeditor.ts:684


change

change(handler): void

Parameters

Name Type
handler (e: Event) => void

Returns

void

Inherited from

ComboboxEditor.change

Defined in

src/ui/widgets/widget.ts:114


changeSelect2

changeSelect2(handler): void

Parameters

Name Type
handler (e: Event) => void

Returns

void

Inherited from

ComboboxEditor.changeSelect2

Defined in

src/ui/widgets/widget.ts:118


clearItems

clearItems(): void

Returns

void

Inherited from

ComboboxEditor.clearItems

Defined in

src/ui/editors/comboboxeditor.ts:273


createEditDialog

createEditDialog(callback): void

Parameters

Name Type
callback (dlg: IEditDialog) => void

Returns

void

Inherited from

ComboboxEditor.createEditDialog

Defined in

src/ui/editors/comboboxeditor.ts:733


destroy

destroy(): void

Returns

void

Overrides

ComboboxEditor.destroy

Defined in

src/ui/editors/lookupeditor.ts:31


editDialogDataChange

editDialogDataChange(): void

Returns

void

Overrides

ComboboxEditor.editDialogDataChange

Defined in

src/ui/editors/lookupeditor.ts:141


emptyItemText

emptyItemText(): string

Returns

string

Inherited from

ComboboxEditor.emptyItemText

Defined in

src/ui/editors/comboboxeditor.ts:100


filterItems

filterItems(items): TItem[]

Parameters

Name Type
items TItem[]

Returns

TItem[]

Inherited from

ComboboxEditor.filterItems

Defined in

src/ui/editors/comboboxeditor.ts:706


getCascadeFromValue

getCascadeFromValue(parent): any

Parameters

Name Type
parent Widget<any>

Returns

any

Inherited from

ComboboxEditor.getCascadeFromValue

Defined in

src/ui/editors/comboboxeditor.ts:568


getComboboxContainer

getComboboxContainer(): HTMLElement

Returns

HTMLElement

Inherited from

ComboboxEditor.getComboboxContainer

Defined in

src/ui/editors/comboboxeditor.ts:428


getComboboxOptions

getComboboxOptions(): ComboboxOptions<any>

Returns

ComboboxOptions<any>

Inherited from

ComboboxEditor.getComboboxOptions

Defined in

src/ui/editors/comboboxeditor.ts:161


getCreateSearchChoice

getCreateSearchChoice(getName): (s: string) => { id: string ; text: string }

Parameters

Name Type
getName (z: any) => string

Returns

fn

▸ (s): Object

Parameters
Name Type
s string
Returns

Object

Name Type
id string
text string

Inherited from

ComboboxEditor.getCreateSearchChoice

Defined in

src/ui/editors/comboboxeditor.ts:363


getCssClass

getCssClass(): string

Returns

string

Inherited from

ComboboxEditor.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

ComboboxEditor.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138


getDialogTypeKey

getDialogTypeKey(): string

Returns

string

Overrides

ComboboxEditor.getDialogTypeKey

Defined in

src/ui/editors/lookupeditor.ts:129


getEditValue

getEditValue(property, target): void

Parameters

Name Type
property PropertyItem
target any

Returns

void

Inherited from

ComboboxEditor.getEditValue

Defined in

src/ui/editors/comboboxeditor.ts:419


getFieldElement

getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

ComboboxEditor.getFieldElement

Defined in

src/ui/widgets/widget.ts:106


getGridField

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

ComboboxEditor.getGridField

Defined in

src/ui/widgets/widget.ts:110


getIdField

getIdField(): any

Returns

any

Overrides

ComboboxEditor.getIdField

Defined in

src/ui/editors/lookupeditor.ts:73


getItemDisabled

getItemDisabled(item, lookup): boolean

Parameters

Name Type
item TItem
lookup Lookup<TItem>

Returns

boolean

Defined in

src/ui/editors/lookupeditor.ts:94


getItemText

getItemText(item, lookup): any

Parameters

Name Type
item TItem
lookup Lookup<TItem>

Returns

any

Defined in

src/ui/editors/lookupeditor.ts:77


getItems

getItems(lookup): TItem[]

Parameters

Name Type
lookup Lookup<TItem>

Returns

TItem[]

Defined in

src/ui/editors/lookupeditor.ts:69


getLookup

getLookup(): Lookup<TItem>

Returns

Lookup<TItem>

Defined in

src/ui/editors/lookupeditor.ts:65


getLookupAsync

getLookupAsync(): PromiseLike<Lookup<TItem>>

Returns

PromiseLike<Lookup<TItem>>

Defined in

src/ui/editors/lookupeditor.ts:61


getLookupKey

getLookupKey(): string

Returns

string

Defined in

src/ui/editors/lookupeditor.ts:40


getPageSize

getPageSize(): number

Returns

number

Inherited from

ComboboxEditor.getPageSize

Defined in

src/ui/editors/comboboxeditor.ts:105


getTextField

getTextField(): any

Returns

any

Inherited from

ComboboxEditor.getTextField

Defined in

src/ui/editors/comboboxeditor.ts:120


getTypeDelay

getTypeDelay(): any

Returns

any

Inherited from

ComboboxEditor.getTypeDelay

Defined in

src/ui/editors/comboboxeditor.ts:96


get_cascadeField

get_cascadeField(): string

Returns

string

Inherited from

ComboboxEditor.get_cascadeField

Defined in

src/ui/editors/comboboxeditor.ts:612


get_cascadeFrom

get_cascadeFrom(): string

Returns

string

Inherited from

ComboboxEditor.get_cascadeFrom

Defined in

src/ui/editors/comboboxeditor.ts:593


get_cascadeValue

get_cascadeValue(): any

Returns

any

Inherited from

ComboboxEditor.get_cascadeValue

Defined in

src/ui/editors/comboboxeditor.ts:628


get_delimited

get_delimited(): boolean

Returns

boolean

Inherited from

ComboboxEditor.get_delimited

Defined in

src/ui/editors/comboboxeditor.ts:238


get_filterField

get_filterField(): string

Returns

string

Inherited from

ComboboxEditor.get_filterField

Defined in

src/ui/editors/comboboxeditor.ts:648


get_filterValue

get_filterValue(): any

Returns

any

Inherited from

ComboboxEditor.get_filterValue

Defined in

src/ui/editors/comboboxeditor.ts:664


get_itemByKey

get_itemByKey(): Object

Returns

Object

Inherited from

ComboboxEditor.get_itemByKey

Defined in

src/ui/editors/comboboxeditor.ts:436


get_items

get_items(): ComboboxItem<TItem>[]

Returns

ComboboxItem<TItem>[]

Inherited from

ComboboxEditor.get_items

Defined in

src/ui/editors/comboboxeditor.ts:432


get_readOnly

get_readOnly(): boolean

Returns

boolean

Inherited from

ComboboxEditor.get_readOnly

Defined in

src/ui/editors/comboboxeditor.ts:538


get_text

get_text(): string

Returns

string

Inherited from

ComboboxEditor.get_text

Defined in

src/ui/editors/comboboxeditor.ts:526


get_value

get_value(): string

Returns

string

Inherited from

ComboboxEditor.get_value

Defined in

src/ui/editors/comboboxeditor.ts:462


get_values

get_values(): string[]

Returns

string[]

Inherited from

ComboboxEditor.get_values

Defined in

src/ui/editors/comboboxeditor.ts:510


hasAsyncSource

hasAsyncSource(): boolean

Returns

boolean

Overrides

ComboboxEditor.hasAsyncSource

Defined in

src/ui/editors/lookupeditor.ts:27


init

init(): this

Returns

this

Inherited from

ComboboxEditor.init

Defined in

src/ui/widgets/widget.ts:146


initNewEntity

initNewEntity(entity): void

Parameters

Name Type
entity TItem

Returns

void

Inherited from

ComboboxEditor.initNewEntity

Defined in

src/ui/editors/comboboxeditor.ts:742


inplaceCreateClick

inplaceCreateClick(e): void

Parameters

Name Type
e Event

Returns

void

Inherited from

ComboboxEditor.inplaceCreateClick

Defined in

src/ui/editors/comboboxeditor.ts:771


internalInit

internalInit(): void

Returns

void

Inherited from

ComboboxEditor.internalInit

Defined in

src/ui/widgets/widget.ts:142


internalRenderContents

internalRenderContents(): void

Returns

void

Inherited from

ComboboxEditor.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169


isAutoComplete

isAutoComplete(): boolean

Returns

boolean

Inherited from

ComboboxEditor.isAutoComplete

Defined in

src/ui/editors/comboboxeditor.ts:359


isMultiple

isMultiple(): boolean

Returns

boolean

Inherited from

ComboboxEditor.isMultiple

Defined in

src/ui/editors/comboboxeditor.ts:153


itemDisabled

itemDisabled(item): boolean

Parameters

Name Type
item TItem

Returns

boolean

Inherited from

ComboboxEditor.itemDisabled

Defined in

src/ui/editors/comboboxeditor.ts:131


itemId

itemId(item): string

Parameters

Name Type
item TItem

Returns

string

Inherited from

ComboboxEditor.itemId

Defined in

src/ui/editors/comboboxeditor.ts:113


itemText

itemText(item): string

Parameters

Name Type
item TItem

Returns

string

Inherited from

ComboboxEditor.itemText

Defined in

src/ui/editors/comboboxeditor.ts:124


mapItem

mapItem(item): ComboboxItem<TItem>

Parameters

Name Type
item TItem

Returns

ComboboxItem<TItem>

Overrides

ComboboxEditor.mapItem

Defined in

src/ui/editors/lookupeditor.ts:85


mapItems

mapItems(items): ComboboxItem<any>[]

Parameters

Name Type
items TItem[]

Returns

ComboboxItem<any>[]

Inherited from

ComboboxEditor.mapItems

Defined in

src/ui/editors/comboboxeditor.ts:144


openDropdown

openDropdown(): void

Returns

void

Inherited from

ComboboxEditor.openDropdown

Defined in

src/ui/editors/comboboxeditor.ts:842


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

ComboboxEditor.render

Defined in

src/ui/widgets/widget.ts:159


renderContents

renderContents(): any

Returns

any

Inherited from

ComboboxEditor.renderContents

Defined in

src/ui/widgets/widget.ts:178


setCascadeFrom

setCascadeFrom(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

ComboboxEditor.setCascadeFrom

Defined in

src/ui/editors/comboboxeditor.ts:574


setCreateTermOnNewEntity

setCreateTermOnNewEntity(entity, term): void

Parameters

Name Type
entity TItem
term string

Returns

void

Defined in

src/ui/editors/lookupeditor.ts:137


setEditDialogReadOnly

setEditDialogReadOnly(dialog): void

Parameters

Name Type
dialog any

Returns

void

Inherited from

ComboboxEditor.setEditDialogReadOnly

Defined in

src/ui/editors/comboboxeditor.ts:756


setEditValue

setEditValue(source, property): void

Parameters

Name Type
source any
property PropertyItem

Returns

void

Inherited from

ComboboxEditor.setEditValue

Defined in

src/ui/editors/comboboxeditor.ts:409


setTermOnNewEntity

setTermOnNewEntity(entity, term): void

Parameters

Name Type
entity TItem
term string

Returns

void

Inherited from

ComboboxEditor.setTermOnNewEntity

Defined in

src/ui/editors/comboboxeditor.ts:768


set_cascadeField

set_cascadeField(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

ComboboxEditor.set_cascadeField

Defined in

src/ui/editors/comboboxeditor.ts:620


set_cascadeFrom

set_cascadeFrom(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

ComboboxEditor.set_cascadeFrom

Defined in

src/ui/editors/comboboxeditor.ts:601


set_cascadeValue

set_cascadeValue(value): void

Parameters

Name Type
value any

Returns

void

Inherited from

ComboboxEditor.set_cascadeValue

Defined in

src/ui/editors/comboboxeditor.ts:636


set_filterField

set_filterField(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

ComboboxEditor.set_filterField

Defined in

src/ui/editors/comboboxeditor.ts:656


set_filterValue

set_filterValue(value): void

Parameters

Name Type
value any

Returns

void

Inherited from

ComboboxEditor.set_filterValue

Defined in

src/ui/editors/comboboxeditor.ts:672


set_readOnly

set_readOnly(value): void

Parameters

Name Type
value boolean

Returns

void

Inherited from

ComboboxEditor.set_readOnly

Defined in

src/ui/editors/comboboxeditor.ts:557


set_value

set_value(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

ComboboxEditor.set_value

Defined in

src/ui/editors/comboboxeditor.ts:470


set_values

set_values(value): void

Parameters

Name Type
value string[]

Returns

void

Inherited from

ComboboxEditor.set_values

Defined in

src/ui/editors/comboboxeditor.ts:518


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

ComboboxEditor.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186


updateItems

updateItems(): void

Returns

void

Overrides

ComboboxEditor.updateItems

Defined in

src/ui/editors/lookupeditor.ts:98


useIdPrefix

useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

ComboboxEditor.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193


useInplaceAdd

useInplaceAdd(): boolean

Returns

boolean

Inherited from

ComboboxEditor.useInplaceAdd

Defined in

src/ui/editors/comboboxeditor.ts:352


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

ComboboxEditor.create

Defined in

src/ui/widgets/widget.ts:126


createDefaultElement

createDefaultElement(): HTMLInputElement

Returns

HTMLInputElement

Inherited from

ComboboxEditor.createDefaultElement

Defined in

src/ui/editors/comboboxeditor.ts:43


filterByText

filterByText<TItem>(items, getText, term): TItem[]

Type parameters

Name
TItem

Parameters

Name Type
items TItem[]
getText (item: TItem) => string
term string

Returns

TItem[]

Inherited from

ComboboxEditor.filterByText

Defined in

src/ui/editors/comboboxeditor.ts:440


getWidgetName

getWidgetName(type): string

Parameters

Name Type
type Function

Returns

string

Inherited from

ComboboxEditor.getWidgetName

Defined in

src/ui/widgets/widget.ts:95