@serenity-is/corelib / ComboboxEditor

Class: ComboboxEditor<P, TItem>

Type parameters

Name
P
TItem

Hierarchy

• Widget<P>

  ↳ ComboboxEditor

  ↳↳ SelectEditor

  ↳↳ EnumEditor

  ↳↳ LookupEditorBase

  ↳↳ ServiceLookupEditorBase

Implements

• ISetEditValue
• IGetEditValue
• IStringValue
• IReadOnly

Table of contents

Constructors

• constructor

Properties

• cascadeLink
• domNode
• idPrefix
• lastCreateTerm
• onInitNewEntity
• openDialogAsPanel
• options
• uniqueName
• typeInfo

Accessors

• cascadeField
• cascadeFrom
• cascadeValue
• element
• filterField
• filterValue
• itemById
• items
• props
• readOnly
• selectedItem
• selectedItems
• text
• value
• values

Methods

• abortPendingQuery
• addCssClass
• addInplaceCreate
• addItem
• addOption
• addValidationRule
• allowClear
• asyncSearch
• cascadeItems
• change
• changeSelect2
• clearItems
• createEditDialog
• destroy
• editDialogDataChange
• emptyItemText
• filterItems
• getCascadeFromValue
• getComboboxContainer
• getComboboxOptions
• getCreateSearchChoice
• getCssClass
• getCustomAttribute
• getDialogTypeKey
• getEditValue
• getFieldElement
• getGridField
• getIdField
• getPageSize
• getTextField
• getTypeDelay
• get_cascadeField
• get_cascadeFrom
• get_cascadeValue
• get_delimited
• get_filterField
• get_filterValue
• get_itemByKey
• get_items
• get_readOnly
• get_text
• get_value
• get_values
• hasAsyncSource
• init
• initNewEntity
• inplaceCreateClick
• internalInit
• internalRenderContents
• isAutoComplete
• isMultiple
• itemDisabled
• itemId
• itemText
• mapItem
• mapItems
• openDropdown
• render
• renderContents
• setCascadeFrom
• setEditDialogReadOnly
• setEditValue
• setTermOnNewEntity
• set_cascadeField
• set_cascadeFrom
• set_cascadeValue
• set_filterField
• set_filterValue
• set_readOnly
• set_value
• set_values
• syncOrAsyncThen
• updateItems
• useIdPrefix
• useInplaceAdd
• create
• createDefaultElement
• filterByText
• getWidgetName

Constructors

constructor

• new ComboboxEditor<P, TItem>(props): ComboboxEditor<P, TItem>

Type parameters

Name
P
TItem

Parameters

Name	Type
props	EditorProps<P>

Returns

ComboboxEditor<P, TItem>

Overrides

Widget.constructor

Defined in

src/ui/editors/comboboxeditor.ts:51

Properties

cascadeLink

• Protected cascadeLink: CascadedWidgetLink<Widget<any>>

Defined in

src/ui/editors/comboboxeditor.ts:572

---

domNode

• Readonly domNode: HTMLInputElement

Overrides

Widget.domNode

Defined in

src/ui/editors/comboboxeditor.ts:44

---

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

lastCreateTerm

• Protected lastCreateTerm: string

Defined in

src/ui/editors/comboboxeditor.ts:49

---

onInitNewEntity

• onInitNewEntity: (entity: TItem) => void

Type declaration

▸ (entity): void

Parameters

Name	Type
entity	TItem

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:740

---

openDialogAsPanel

• openDialogAsPanel: boolean

Defined in

src/ui/editors/comboboxeditor.ts:846

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:15

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

typeInfo

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

Inherited from

Widget.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

cascadeField

• get cascadeField(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:616

• set cascadeField(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:624

---

cascadeFrom

• get cascadeFrom(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:597

• set cascadeFrom(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:608

---

cascadeValue

• get cascadeValue(): any

Returns

any

Defined in

src/ui/editors/comboboxeditor.ts:632

• set cascadeValue(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:644

---

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:67

---

filterField

• get filterField(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:652

• set filterField(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:660

---

filterValue

• get filterValue(): any

Returns

any

Defined in

src/ui/editors/comboboxeditor.ts:668

• set filterValue(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:680

---

itemById

• get itemById(): Object

Returns

Object

Defined in

src/ui/editors/comboboxeditor.ts:259

• set itemById(value): void

Parameters

Name	Type
value	Object

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:266

---

items

• get items(): ComboboxItem<TItem>[]

Returns

ComboboxItem<TItem>[]

Defined in

src/ui/editors/comboboxeditor.ts:242

• set items(value): void

Parameters

Name	Type
value	ComboboxItem<TItem>[]

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:249

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

Widget.props

Defined in

src/ui/widgets/widget.ts:182

---

readOnly

• get readOnly(): boolean

Returns

boolean

Defined in

src/ui/editors/comboboxeditor.ts:542

• set readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:564

---

selectedItem

• get selectedItem(): TItem

Returns

TItem

Defined in

src/ui/editors/comboboxeditor.ts:485

---

selectedItems

• get selectedItems(): TItem[]

Returns

TItem[]

Defined in

src/ui/editors/comboboxeditor.ts:495

---

text

• get text(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:534

---

value

• get value(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:466

• set value(v): void

Parameters

Name	Type
v	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:481

---

values

• get values(): string[]

Returns

string[]

Defined in

src/ui/editors/comboboxeditor.ts:514

• set values(value): void

Parameters

Name	Type
value	string[]

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:522

Methods

abortPendingQuery

▸ abortPendingQuery(): void

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:157

---

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:71

---

addInplaceCreate

▸ addInplaceCreate(addTitle, editTitle): void

Parameters

Name	Type
addTitle	string
editTitle	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:298

---

addItem

▸ addItem(item): void

Parameters

Name	Type
item	ComboboxItem<TItem>

Returns

void

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

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

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

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

allowClear

▸ allowClear(): boolean

Returns

boolean

Defined in

src/ui/editors/comboboxeditor.ts:148

---

asyncSearch

▸ asyncSearch(query): PromiseLike<ComboboxSearchResult<TItem>>

Parameters

Name	Type
query	ComboboxSearchQuery

Returns

PromiseLike<ComboboxSearchResult<TItem>>

Defined in

src/ui/editors/comboboxeditor.ts:89

---

cascadeItems

▸ cascadeItems(items): TItem[]

Parameters

Name	Type
items	TItem[]

Returns

TItem[]

Defined in

src/ui/editors/comboboxeditor.ts:684

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

clearItems

▸ clearItems(): void

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:273

---

createEditDialog

▸ createEditDialog(callback): void

Parameters

Name	Type
callback	(dlg: IEditDialog) => void

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:733

---

destroy

▸ destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/editors/comboboxeditor.ts:79

---

editDialogDataChange

▸ editDialogDataChange(): void

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:765

---

emptyItemText

▸ emptyItemText(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:100

---

filterItems

▸ filterItems(items): TItem[]

Parameters

Name	Type
items	TItem[]

Returns

TItem[]

Defined in

src/ui/editors/comboboxeditor.ts:706

---

getCascadeFromValue

▸ getCascadeFromValue(parent): any

Parameters

Name	Type
parent	Widget<any>

Returns

any

Defined in

src/ui/editors/comboboxeditor.ts:568

---

getComboboxContainer

▸ getComboboxContainer(): HTMLElement

Returns

HTMLElement

Defined in

src/ui/editors/comboboxeditor.ts:428

---

getComboboxOptions

▸ getComboboxOptions(): ComboboxOptions<any>

Returns

ComboboxOptions<any>

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

Defined in

src/ui/editors/comboboxeditor.ts:363

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

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

Widget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getDialogTypeKey

▸ getDialogTypeKey(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:725

---

getEditValue

▸ getEditValue(property, target): void

Parameters

Name	Type
property	PropertyItem
target	any

Returns

void

Implementation of

IGetEditValue.getEditValue

Defined in

src/ui/editors/comboboxeditor.ts:419

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

Widget.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getIdField

▸ getIdField(): any

Returns

any

Defined in

src/ui/editors/comboboxeditor.ts:109

---

getPageSize

▸ getPageSize(): number

Returns

number

Defined in

src/ui/editors/comboboxeditor.ts:105

---

getTextField

▸ getTextField(): any

Returns

any

Defined in

src/ui/editors/comboboxeditor.ts:120

---

getTypeDelay

▸ getTypeDelay(): any

Returns

any

Defined in

src/ui/editors/comboboxeditor.ts:96

---

get_cascadeField

▸ get_cascadeField(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:612

---

get_cascadeFrom

▸ get_cascadeFrom(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:593

---

get_cascadeValue

▸ get_cascadeValue(): any

Returns

any

Defined in

src/ui/editors/comboboxeditor.ts:628

---

get_delimited

▸ get_delimited(): boolean

Returns

boolean

Defined in

src/ui/editors/comboboxeditor.ts:238

---

get_filterField

▸ get_filterField(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:648

---

get_filterValue

▸ get_filterValue(): any

Returns

any

Defined in

src/ui/editors/comboboxeditor.ts:664

---

get_itemByKey

▸ get_itemByKey(): Object

Returns

Object

Defined in

src/ui/editors/comboboxeditor.ts:436

---

get_items

▸ get_items(): ComboboxItem<TItem>[]

Returns

ComboboxItem<TItem>[]

Defined in

src/ui/editors/comboboxeditor.ts:432

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/editors/comboboxeditor.ts:538

---

get_text

▸ get_text(): string

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:526

---

get_value

▸ get_value(): string

Returns

string

Implementation of

IStringValue.get_value

Defined in

src/ui/editors/comboboxeditor.ts:462

---

get_values

▸ get_values(): string[]

Returns

string[]

Defined in

src/ui/editors/comboboxeditor.ts:510

---

hasAsyncSource

▸ hasAsyncSource(): boolean

Returns

boolean

Defined in

src/ui/editors/comboboxeditor.ts:85

---

init

▸ init(): this

Returns

this

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:146

---

initNewEntity

▸ initNewEntity(entity): void

Parameters

Name	Type
entity	TItem

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:742

---

inplaceCreateClick

▸ inplaceCreateClick(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:771

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

Widget.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

Widget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

isAutoComplete

▸ isAutoComplete(): boolean

Returns

boolean

Defined in

src/ui/editors/comboboxeditor.ts:359

---

isMultiple

▸ isMultiple(): boolean

Returns

boolean

Defined in

src/ui/editors/comboboxeditor.ts:153

---

itemDisabled

▸ itemDisabled(item): boolean

Parameters

Name	Type
item	TItem

Returns

boolean

Defined in

src/ui/editors/comboboxeditor.ts:131

---

itemId

▸ itemId(item): string

Parameters

Name	Type
item	TItem

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:113

---

itemText

▸ itemText(item): string

Parameters

Name	Type
item	TItem

Returns

string

Defined in

src/ui/editors/comboboxeditor.ts:124

---

mapItem

▸ mapItem(item): ComboboxItem<any>

Parameters

Name	Type
item	TItem

Returns

ComboboxItem<any>

Defined in

src/ui/editors/comboboxeditor.ts:135

---

mapItems

▸ mapItems(items): ComboboxItem<any>[]

Parameters

Name	Type
items	TItem[]

Returns

ComboboxItem<any>[]

Defined in

src/ui/editors/comboboxeditor.ts:144

---

openDropdown

▸ openDropdown(): void

Returns

void

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

Widget.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): any

Returns

any

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:178

---

setCascadeFrom

▸ setCascadeFrom(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:574

---

setEditDialogReadOnly

▸ setEditDialogReadOnly(dialog): void

Parameters

Name	Type
dialog	any

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:756

---

setEditValue

▸ setEditValue(source, property): void

Parameters

Name	Type
source	any
property	PropertyItem

Returns

void

Implementation of

ISetEditValue.setEditValue

Defined in

src/ui/editors/comboboxeditor.ts:409

---

setTermOnNewEntity

▸ setTermOnNewEntity(entity, term): void

Parameters

Name	Type
entity	TItem
term	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:768

---

set_cascadeField

▸ set_cascadeField(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:620

---

set_cascadeFrom

▸ set_cascadeFrom(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:601

---

set_cascadeValue

▸ set_cascadeValue(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:636

---

set_filterField

▸ set_filterField(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:656

---

set_filterValue

▸ set_filterValue(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:672

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/editors/comboboxeditor.ts:557

---

set_value

▸ set_value(value): void

Parameters

Name	Type
value	string

Returns

void

Implementation of

IStringValue.set_value

Defined in

src/ui/editors/comboboxeditor.ts:470

---

set_values

▸ set_values(value): void

Parameters

Name	Type
value	string[]

Returns

void

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

Widget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

updateItems

▸ updateItems(): void

Returns

void

Defined in

src/ui/editors/comboboxeditor.ts:722

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

Widget.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

useInplaceAdd

▸ useInplaceAdd(): boolean

Returns

boolean

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

Widget.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLInputElement

Returns

HTMLInputElement

Overrides

Widget.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[]

Defined in

src/ui/editors/comboboxeditor.ts:440

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95