@serenity-is/corelib / ComboboxEditor

Class: ComboboxEditor<P, TItem>

Defined in: src/ui/editors/comboboxeditor.tsx:39

Extends

EditorWidget<P>

Extended by

Type Parameters

P

P

TItem

TItem

Implements

Constructors

Constructor

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

Defined in: src/ui/editors/comboboxeditor.tsx:51

Parameters

props

EditorProps<P>

Returns

ComboboxEditor<P, TItem>

Overrides

EditorWidget.constructor

Properties

cascadeLink

protected cascadeLink: CascadedWidgetLink<Widget<any>>

Defined in: src/ui/editors/comboboxeditor.tsx:574

domNode

readonly domNode: HTMLInputElement

Defined in: src/ui/editors/comboboxeditor.tsx:44

Overrides

EditorWidget.domNode

idPrefix

readonly idPrefix: string

Defined in: src/ui/widgets/widget.ts:13

Inherited from

EditorWidget.idPrefix

lastCreateTerm

protected lastCreateTerm: string

Defined in: src/ui/editors/comboboxeditor.tsx:49

onInitNewEntity()

onInitNewEntity: (entity) => void

Defined in: src/ui/editors/comboboxeditor.tsx:745

Parameters

entity

TItem

Returns

void

openDialogAsPanel

openDialogAsPanel: boolean

Defined in: src/ui/editors/comboboxeditor.tsx:857

options

protected readonly options: WidgetProps<EditorProps<P>>

Defined in: src/ui/widgets/widget.ts:11

Inherited from

EditorWidget.options

uniqueName

readonly uniqueName: string

Defined in: src/ui/widgets/widget.ts:12

Inherited from

EditorWidget.uniqueName

[typeInfo]

static [typeInfo]: ClassTypeInfo<"Serenity.">

Defined in: src/ui/editors/comboboxeditor.tsx:41

Implementation of

IReadOnly.[typeInfo]

Overrides

EditorWidget.[typeInfo]

isComponent

readonly static isComponent: true = true

Defined in: src/ui/widgets/widget.ts:219

Inherited from

EditorWidget.isComponent

Accessors

cascadeField

Get Signature

get cascadeField(): string

Defined in: src/ui/editors/comboboxeditor.tsx:618

Returns

string

Set Signature

set cascadeField(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:626

Parameters

value

string

Returns

void

cascadeFrom

Get Signature

get cascadeFrom(): string

Defined in: src/ui/editors/comboboxeditor.tsx:599

Returns

string

Set Signature

set cascadeFrom(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:610

Parameters

value

string

Returns

void

cascadeValue

Get Signature

get cascadeValue(): any

Defined in: src/ui/editors/comboboxeditor.tsx:634

Returns

any

Set Signature

set cascadeValue(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:646

Parameters

value

any

Returns

void

element

Get Signature

get element(): Fluent

Defined in: src/ui/widgets/widget.ts:59

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

EditorWidget.element

filterField

Get Signature

get filterField(): string

Defined in: src/ui/editors/comboboxeditor.tsx:654

Returns

string

Set Signature

set filterField(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:662

Parameters

value

string

Returns

void

filterValue

Get Signature

get filterValue(): any

Defined in: src/ui/editors/comboboxeditor.tsx:670

Returns

any

Set Signature

set filterValue(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:682

Parameters

value

any

Returns

void

itemById

Get Signature

get protected itemById(): object

Defined in: src/ui/editors/comboboxeditor.tsx:272

Returns

object

Set Signature

set protected itemById(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:279

Parameters

value

Returns

void

items

Get Signature

get items(): ComboboxItem<TItem>[]

Defined in: src/ui/editors/comboboxeditor.tsx:255

Returns

ComboboxItem<TItem>[]

Set Signature

set items(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:262

Parameters

value

ComboboxItem<TItem>[]

Returns

void

props

Get Signature

get props(): WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:203

Returns

WidgetProps<P>

Inherited from

EditorWidget.props

readOnly

Get Signature

get readOnly(): boolean

Defined in: src/ui/editors/editorwidget.ts:20

Returns

boolean

Set Signature

set readOnly(value): void

Defined in: src/ui/editors/editorwidget.ts:25

Parameters

value

boolean

Returns

void

Inherited from

EditorWidget.readOnly

selectedItem

Get Signature

get selectedItem(): TItem

Defined in: src/ui/editors/comboboxeditor.tsx:495

Returns

TItem

selectedItems

Get Signature

get selectedItems(): TItem[]

Defined in: src/ui/editors/comboboxeditor.tsx:505

Returns

TItem[]

text

Get Signature

get text(): string

Defined in: src/ui/editors/comboboxeditor.tsx:544

Returns

string

value

Get Signature

get value(): string

Defined in: src/ui/editors/comboboxeditor.tsx:476

Returns

string

Set Signature

set value(v): void

Defined in: src/ui/editors/comboboxeditor.tsx:491

Parameters

v

string

Returns

void

values

Get Signature

get values(): string[]

Defined in: src/ui/editors/comboboxeditor.tsx:524

Returns

string[]

Set Signature

set values(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:532

Parameters

value

string[]

Returns

void

Methods

abortPendingQuery()

protected abortPendingQuery(): void

Defined in: src/ui/editors/comboboxeditor.tsx:157

Returns

void

addCssClass()

protected addCssClass(): void

Defined in: src/ui/widgets/widget.ts:63

Returns

void

Inherited from

EditorWidget.addCssClass

addInplaceCreate()

protected addInplaceCreate(addTitle, editTitle): void

Defined in: src/ui/editors/comboboxeditor.tsx:311

Parameters

addTitle

string

editTitle

string

Returns

void

addItem()

addItem(item): void

Defined in: src/ui/editors/comboboxeditor.tsx:294

Parameters

item

ComboboxItem<TItem>

Returns

void

addOption()

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

Defined in: src/ui/editors/comboboxeditor.tsx:302

Parameters

key

string

text

string

source?

any

disabled?

boolean

Returns

void

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Defined in: src/ui/widgets/widget.ts:95

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

EditorWidget.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

Defined in: src/ui/widgets/widget.ts:96

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

EditorWidget.addValidationRule

afterRender()

protected afterRender(callback): void

Defined in: src/ui/widgets/widget.ts:142

Parameters

callback

() => void

Returns

void

Inherited from

EditorWidget.afterRender

allowClear()

protected allowClear(): boolean

Defined in: src/ui/editors/comboboxeditor.tsx:148

Returns

boolean

asyncSearch()

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

Defined in: src/ui/editors/comboboxeditor.tsx:89

Parameters

query

ComboboxSearchQuery

Returns

PromiseLike<ComboboxSearchResult<TItem>>

byId()

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

Defined in: src/ui/widgets/widget.ts:102

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

EditorWidget.byId

cascadeItems()

protected cascadeItems(items): TItem[]

Defined in: src/ui/editors/comboboxeditor.tsx:686

Parameters

items

TItem[]

Returns

TItem[]

change()

change(handler): void

Defined in: src/ui/widgets/widget.ts:114

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.change

changeSelect2()

changeSelect2(handler): void

Defined in: src/ui/widgets/widget.ts:118

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.changeSelect2

clearItems()

clearItems(): void

Defined in: src/ui/editors/comboboxeditor.tsx:286

Returns

void

createEditDialog()

protected createEditDialog(callback): void

Defined in: src/ui/editors/comboboxeditor.tsx:735

Parameters

callback

(dlg) => void

Returns

void

deferRender()

protected deferRender(): boolean

Defined in: src/ui/widgets/widget.ts:67

Returns

boolean

Inherited from

EditorWidget.deferRender

destroy()

destroy(): void

Defined in: src/ui/editors/comboboxeditor.tsx:79

Returns

void

Overrides

EditorWidget.destroy

editDialogDataChange()

protected editDialogDataChange(): void

Defined in: src/ui/editors/comboboxeditor.tsx:770

Returns

void

emptyItemText()

protected emptyItemText(): string

Defined in: src/ui/editors/comboboxeditor.tsx:100

Returns

string

filterItems()

protected filterItems(items): TItem[]

Defined in: src/ui/editors/comboboxeditor.tsx:708

Parameters

items

TItem[]

Returns

TItem[]

findById()

protected findById<TElement>(id): TElement

Defined in: src/ui/widgets/widget.ts:106

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

EditorWidget.findById

get_cascadeField()

protected get_cascadeField(): string

Defined in: src/ui/editors/comboboxeditor.tsx:614

Returns

string

get_cascadeFrom()

protected get_cascadeFrom(): string

Defined in: src/ui/editors/comboboxeditor.tsx:595

Returns

string

get_cascadeValue()

protected get_cascadeValue(): any

Defined in: src/ui/editors/comboboxeditor.tsx:630

Returns

any

get_delimited()

get_delimited(): boolean

Defined in: src/ui/editors/comboboxeditor.tsx:251

Returns

boolean

get_filterField()

protected get_filterField(): string

Defined in: src/ui/editors/comboboxeditor.tsx:650

Returns

string

get_filterValue()

protected get_filterValue(): any

Defined in: src/ui/editors/comboboxeditor.tsx:666

Returns

any

get_itemByKey()

protected get_itemByKey(): object

Defined in: src/ui/editors/comboboxeditor.tsx:446

Returns

object

get_items()

protected get_items(): ComboboxItem<TItem>[]

Defined in: src/ui/editors/comboboxeditor.tsx:442

Returns

ComboboxItem<TItem>[]

get_readOnly()

get_readOnly(): boolean

Defined in: src/ui/editors/comboboxeditor.tsx:548

Returns

boolean

Implementation of

IReadOnly.get_readOnly

get_text()

protected get_text(): string

Defined in: src/ui/editors/comboboxeditor.tsx:536

Returns

string

get_value()

get_value(): string

Defined in: src/ui/editors/comboboxeditor.tsx:472

Returns

string

Implementation of

IStringValue.get_value

get_values()

protected get_values(): string[]

Defined in: src/ui/editors/comboboxeditor.tsx:520

Returns

string[]

getCascadeFromValue()

protected getCascadeFromValue(parent): any

Defined in: src/ui/editors/comboboxeditor.tsx:570

Parameters

parent

Widget<any>

Returns

any

getComboboxContainer()

protected getComboboxContainer(): HTMLElement

Defined in: src/ui/editors/comboboxeditor.tsx:438

Returns

HTMLElement

getComboboxOptions()

protected getComboboxOptions(): ComboboxOptions

Defined in: src/ui/editors/comboboxeditor.tsx:161

Returns

ComboboxOptions

getCreateSearchChoice()

getCreateSearchChoice(getName): (s) => object

Defined in: src/ui/editors/comboboxeditor.tsx:373

Parameters

getName

(z) => string

Returns

(s): object

Parameters

s

string

Returns

object

id

id: string

text

text: string

getCssClass()

protected getCssClass(): string

Defined in: src/ui/widgets/widget.ts:71

Returns

string

Inherited from

EditorWidget.getCssClass

getCustomAttribute()

protected getCustomAttribute<TAttr>(attrType, inherit): TAttr

Defined in: src/ui/widgets/widget.ts:138

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

EditorWidget.getCustomAttribute

getDialogTypeKey()

protected getDialogTypeKey(): string

Defined in: src/ui/editors/comboboxeditor.tsx:727

Returns

string

getEditValue()

getEditValue(property, target): void

Defined in: src/ui/editors/comboboxeditor.tsx:429

Parameters

property

PropertyItem

target

any

Returns

void

Implementation of

IGetEditValue.getEditValue

getGridField()

getGridField(): Fluent

Defined in: src/ui/widgets/widget.ts:110

Returns

Fluent

Inherited from

EditorWidget.getGridField

getIdField()

protected getIdField(): any

Defined in: src/ui/editors/comboboxeditor.tsx:109

Returns

any

getPageSize()

protected getPageSize(): number

Defined in: src/ui/editors/comboboxeditor.tsx:105

Returns

number

getTextField()

protected getTextField(): any

Defined in: src/ui/editors/comboboxeditor.tsx:120

Returns

any

getTypeDelay()

protected getTypeDelay(): any

Defined in: src/ui/editors/comboboxeditor.tsx:96

Returns

any

hasAsyncSource()

protected hasAsyncSource(): boolean

Defined in: src/ui/editors/comboboxeditor.tsx:85

Returns

boolean

init()

init(): this

Defined in: src/ui/widgets/widget.ts:153

Returns

this

Inherited from

EditorWidget.init

initNewEntity()

protected initNewEntity(entity): void

Defined in: src/ui/editors/comboboxeditor.tsx:747

Parameters

entity

TItem

Returns

void

inplaceCreateClick()

protected inplaceCreateClick(e): void

Defined in: src/ui/editors/comboboxeditor.tsx:782

Parameters

e

Event

Returns

void

internalRenderContents()

internalRenderContents(): void

Defined in: src/ui/widgets/widget.ts:173

Returns

void

Inherited from

EditorWidget.internalRenderContents

isAutoComplete()

protected isAutoComplete(): boolean

Defined in: src/ui/editors/comboboxeditor.tsx:369

Returns

boolean

isMultiple()

protected isMultiple(): boolean

Defined in: src/ui/editors/comboboxeditor.tsx:153

Returns

boolean

itemDisabled()

protected itemDisabled(item): boolean

Defined in: src/ui/editors/comboboxeditor.tsx:131

Parameters

item

TItem

Returns

boolean

itemId()

protected itemId(item): string

Defined in: src/ui/editors/comboboxeditor.tsx:113

Parameters

item

TItem

Returns

string

itemText()

protected itemText(item): string

Defined in: src/ui/editors/comboboxeditor.tsx:124

Parameters

item

TItem

Returns

string

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Defined in: src/ui/widgets/widget.ts:190

Returns

boolean

Inherited from

EditorWidget.legacyTemplateRender

mapItem()

protected mapItem(item): ComboboxItem

Defined in: src/ui/editors/comboboxeditor.tsx:135

Parameters

item

TItem

Returns

ComboboxItem

mapItems()

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

Defined in: src/ui/editors/comboboxeditor.tsx:144

Parameters

items

TItem[]

Returns

ComboboxItem<any>[]

openDropdown()

openDropdown(): void

Defined in: src/ui/editors/comboboxeditor.tsx:853

Returns

void

render()

render(): any

Defined in: src/ui/widgets/widget.ts:163

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

EditorWidget.render

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/widget.ts:184

Returns

any

Inherited from

EditorWidget.renderContents

set_cascadeField()

protected set_cascadeField(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:622

Parameters

value

string

Returns

void

set_cascadeFrom()

protected set_cascadeFrom(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:603

Parameters

value

string

Returns

void

set_cascadeValue()

protected set_cascadeValue(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:638

Parameters

value

any

Returns

void

set_filterField()

protected set_filterField(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:658

Parameters

value

string

Returns

void

set_filterValue()

protected set_filterValue(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:674

Parameters

value

any

Returns

void

set_readOnly()

set_readOnly(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:563

Parameters

value

boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

set_value()

set_value(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:480

Parameters

value

string

Returns

void

Implementation of

IStringValue.set_value

set_values()

protected set_values(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:528

Parameters

value

string[]

Returns

void

setCascadeFrom()

protected setCascadeFrom(value): void

Defined in: src/ui/editors/comboboxeditor.tsx:576

Parameters

value

string

Returns

void

setEditDialogReadOnly()

protected setEditDialogReadOnly(dialog): void

Defined in: src/ui/editors/comboboxeditor.tsx:761

Parameters

dialog

any

Returns

void

setEditValue()

setEditValue(source, property): void

Defined in: src/ui/editors/comboboxeditor.tsx:419

Parameters

source

any

property

PropertyItem

Returns

void

Implementation of

ISetEditValue.setEditValue

setTermOnNewEntity()

protected setTermOnNewEntity(entity, term, dialog): void

Defined in: src/ui/editors/comboboxeditor.tsx:773

Parameters

entity

TItem

term

string

dialog

any

Returns

void

syncOrAsyncThen()

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

Defined in: src/ui/widgets/widget.ts:207

Type Parameters

T

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

EditorWidget.syncOrAsyncThen

updateItems()

protected updateItems(): void

Defined in: src/ui/editors/comboboxeditor.tsx:724

Returns

void

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Defined in: src/ui/widgets/widget.ts:214

Returns

IdPrefixType

Inherited from

EditorWidget.useIdPrefix

useInplaceAdd()

protected useInplaceAdd(): boolean

Defined in: src/ui/editors/comboboxeditor.tsx:362

Returns

boolean

create()

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

Defined in: src/ui/widgets/widget.ts:126

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

EditorWidget.create

createDefaultElement()

static createDefaultElement(): HTMLInputElement

Defined in: src/ui/editors/comboboxeditor.tsx:43

Returns

HTMLInputElement

Overrides

EditorWidget.createDefaultElement

filterByText()

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

Defined in: src/ui/editors/comboboxeditor.tsx:450

Type Parameters

TItem

TItem

Parameters

items

TItem[]

getText

(item) => string

term

string

Returns

TItem[]

getWidgetName()

static getWidgetName(type): string

Defined in: src/ui/widgets/widget.ts:91

Parameters

type

Function

Returns

string

Inherited from

EditorWidget.getWidgetName

registerClass()

protected static registerClass<TypeName>(typeName, intfAndAttr?): ClassTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:221

Type Parameters

TypeName

TypeName

Parameters

registerEditor()

protected static registerEditor<TypeName>(typeName, intfAndAttr?): EditorTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:230

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

EditorTypeInfo<TypeName>

Inherited from

EditorWidget.registerEditor