@serenity-is/corelib / SelectEditor

Class: SelectEditor<P>

Defined in: src/ui/editors/selecteditor.ts:10

An editor that renders a select of items from a static list.

Extends

ComboboxEditor<P, ComboboxItem>

Extended by

DateYearEditor

Type Parameters

P

P extends SelectEditorOptions = SelectEditorOptions

Widget props type.

Constructors

Constructor

new SelectEditor<P>(props): SelectEditor<P>

Defined in: src/ui/editors/selecteditor.ts:17

Creates a select editor.

Parameters

props

EditorProps<P>

Widget props.

Returns

SelectEditor<P>

Overrides

ComboboxEditor.constructor

Properties

cascadeLink

protected cascadeLink: CascadedWidgetLink<Widget<any>>

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

Inherited from

ComboboxEditor.cascadeLink

domNode

readonly domNode: HTMLInputElement

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

The hidden input element that backs the combobox editor.

Inherited from

ComboboxEditor.domNode

idPrefix

readonly idPrefix: string

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

The id prefix used for this widget's child element ids.

Inherited from

ComboboxEditor.idPrefix

lastCreateTerm

protected lastCreateTerm: string

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

Inherited from

ComboboxEditor.lastCreateTerm

onInitNewEntity()

onInitNewEntity: (entity) => void

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

Callback invoked to initialize a new entity for in-place add.

Parameters

entity

ComboboxItem

Returns

void

Inherited from

ComboboxEditor.onInitNewEntity

openDialogAsPanel

openDialogAsPanel: boolean

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

Whether the in-place add dialog opens as a panel.

Inherited from

ComboboxEditor.openDialogAsPanel

options

protected readonly options: WidgetProps<EditorProps<P>>

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

The widget's options/props.

Inherited from

ComboboxEditor.options

uniqueName

readonly uniqueName: string

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

A unique name for this widget instance, used for event namespacing.

Inherited from

ComboboxEditor.uniqueName

[typeInfo]

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

Defined in: src/ui/editors/selecteditor.ts:11

Overrides

ComboboxEditor.[typeInfo]

isComponent

readonly static isComponent: true = true

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

Inherited from

ComboboxEditor.isComponent

Accessors

cascadeField

Get Signature

get cascadeField(): string

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

Returns the cascade field name.

Returns

string

The cascade field.

Set Signature

set cascadeField(value): void

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

Sets the cascade field name.

Parameters

value

string

The field name used for cascading.

Returns

void

Inherited from

ComboboxEditor.cascadeField

cascadeFrom

Get Signature

get cascadeFrom(): string

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

Returns the cascade-from parent id.

Returns

string

The parent id.

Set Signature

set cascadeFrom(value): void

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

Sets the cascade-from parent id.

Parameters

value

string

The parent editor id to cascade from.

Returns

void

Inherited from

ComboboxEditor.cascadeFrom

cascadeValue

Get Signature

get cascadeValue(): any

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

Returns the cascade value.

Returns

any

The cascade value.

Set Signature

set cascadeValue(value): void

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

Sets the cascade value.

Parameters

value

any

The cascade value to filter by.

Returns

void

Inherited from

ComboboxEditor.cascadeValue

element

Get Signature

get element(): Fluent

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

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

ComboboxEditor.element

filterField

Get Signature

get filterField(): string

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

Returns the filter field name.

Returns

string

The filter field.

Set Signature

set filterField(value): void

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

Sets the filter field name.

Parameters

value

string

The field name used for filtering.

Returns

void

Inherited from

ComboboxEditor.filterField

filterValue

Get Signature

get filterValue(): any

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

Returns the filter value.

Returns

any

The filter value.

Set Signature

set filterValue(value): void

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

Sets the filter value.

Parameters

value

any

The filter value to apply.

Returns

void

Inherited from

ComboboxEditor.filterValue

itemById

Get Signature

get protected itemById(): object

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

Returns

object

Set Signature

set protected itemById(value): void

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

Parameters

value

Returns

void

Inherited from

ComboboxEditor.itemById

items

Get Signature

get items(): ComboboxItem<TItem>[]

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

Returns the items in the editor.

Returns

ComboboxItem<TItem>[]

The items.

Set Signature

set items(value): void

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

Sets the items in the editor.

Parameters

value

ComboboxItem<TItem>[]

The combobox items to set.

Returns

void

Inherited from

ComboboxEditor.items

props

Get Signature

get props(): WidgetProps<P>

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

Returns the widget's props/options.

Returns

WidgetProps<P>

Inherited from

ComboboxEditor.props

readOnly

Get Signature

get readOnly(): boolean

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

Returns whether the editor is read-only.

Returns

boolean

True when read-only.

Set Signature

set readOnly(value): void

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

Sets whether the editor is read-only.

Parameters

value

boolean

Returns

void

Inherited from

ComboboxEditor.readOnly

selectedItem

Get Signature

get selectedItem(): TItem

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

Returns the currently selected item.

Returns

TItem

The selected item, or null.

Inherited from

ComboboxEditor.selectedItem

selectedItems

Get Signature

get selectedItems(): TItem[]

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

Returns the currently selected items.

Returns

TItem[]

The selected items.

Inherited from

ComboboxEditor.selectedItems

text

Get Signature

get text(): string

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

Returns the display text of the current selection.

Returns

string

The comma-joined display text of the selected item(s).

Inherited from

ComboboxEditor.text

value

Get Signature

get value(): string

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

Returns the current value.

Returns

string

The value.

Set Signature

set value(v): void

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

Sets the current value.

Parameters

v

string

The single value to set.

Returns

void

Inherited from

ServiceLookupEditor.value

values

Get Signature

get values(): string[]

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

Returns the current values.

Returns

string[]

The values.

Set Signature

set values(value): void

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

Sets the current values.

Parameters

value

string[]

The array of selected values to set.

Returns

void

Inherited from

ComboboxEditor.values

Methods

abortPendingQuery()

protected abortPendingQuery(): void

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

Aborts any pending search query.

Returns

void

Inherited from

ComboboxEditor.abortPendingQuery

addCssClass()

protected addCssClass(): void

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

Adds the widget's CSS class to its DOM node.

Returns

void

Inherited from

ComboboxEditor.addCssClass

addInplaceCreate()

protected addInplaceCreate(addTitle, editTitle): void

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

Adds the in-place create button.

Parameters

addTitle

string

Title for the add button.

editTitle

string

Title for the edit button.

Returns

void

Inherited from

ComboboxEditor.addInplaceCreate

addItem()

addItem(item): void

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

Adds an item to the editor.

Parameters

item

ComboboxItem<ComboboxItem<any>>

The item to add.

Returns

void

Inherited from

ComboboxEditor.addItem

addOption()

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

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

Adds an option to the editor.

Parameters

key

string

The option id.

text

string

The display text.

source?

any

Optional source item.

disabled?

boolean

Whether the option is disabled.

Returns

void

Inherited from

ComboboxEditor.addOption

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

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

Adds a validation rule to the widget's DOM node.

Parameters

rule

(input) => string

The validation rule function, or a unique name when the two-argument overload is used.

uniqueName?

string

A unique name for the rule, or the rule function when the two-argument overload is used.

Returns

void

Inherited from

ComboboxEditor.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

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

Adds a validation rule to the widget's DOM node.

Parameters

uniqueName

string

A unique name for the rule, or the rule function when the two-argument overload is used.

rule

(input) => string

The validation rule function, or a unique name when the two-argument overload is used.

Returns

void

Inherited from

ComboboxEditor.addValidationRule

afterRender()

protected afterRender(callback): void

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

Queues a callback to run after the widget's contents are rendered.

Parameters

callback

() => void

The callback to run after rendering.

Returns

void

Inherited from

ComboboxEditor.afterRender

allowClear()

protected allowClear(): boolean

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

Whether the selection can be cleared.

Returns

boolean

True when clear is allowed.

Inherited from

ComboboxEditor.allowClear

asyncSearch()

protected asyncSearch(query): PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>

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

Performs an asynchronous search.

Parameters

query

ComboboxSearchQuery

The search query.

Returns

PromiseLike<ComboboxSearchResult<ComboboxItem<any>>>

A promise resolving to the search result.

Inherited from

ComboboxEditor.asyncSearch

byId()

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

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

Finds a child element by its prefix-relative id.

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

The id relative to the widget's id prefix.

Returns

Fluent<TElement>

A Fluent wrapper for the matching element.

Inherited from

ComboboxEditor.byId

cascadeItems()

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

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

Filters items by the cascade value.

Parameters

items

ComboboxItem<any>[]

The items to filter.

Returns

ComboboxItem<any>[]

The filtered items.

Inherited from

ComboboxEditor.cascadeItems

change()

change(handler): void

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

Registers a change handler on the widget's DOM node.

Parameters

handler

(e) => void

The change event handler.

Returns

void

Inherited from

ComboboxEditor.change

changeSelect2()

changeSelect2(handler): void

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

Registers a change handler that ignores changes originating from combobox setting values.

Parameters

handler

(e) => void

The change event handler.

Returns

void

Inherited from

ComboboxEditor.changeSelect2

clearItems()

clearItems(): void

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

Clears all items from the editor.

Returns

void

Inherited from

ComboboxEditor.clearItems

createEditDialog()

protected createEditDialog(callback): void

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

Creates an edit dialog for in-place add.

Parameters

callback

(dlg) => void

Callback invoked with the created dialog.

Returns

void

Inherited from

ComboboxEditor.createEditDialog

deferRender()

protected deferRender(): boolean

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

Determines whether rendering should be deferred until init is called.

Returns

boolean

True to defer rendering.

Inherited from

ComboboxEditor.deferRender

destroy()

destroy(): void

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

Disposes the combobox and delegates to the base destroy.

Returns

void

Inherited from

ComboboxEditor.destroy

editDialogDataChange()

protected editDialogDataChange(): void

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

Hook invoked when the edit dialog data changes.

Returns

void

Inherited from

ComboboxEditor.editDialogDataChange

emptyItemText()

protected emptyItemText(): string

Defined in: src/ui/editors/selecteditor.ts:35

Returns the text for the empty option.

Returns

string

The empty option text.

Overrides

ComboboxEditor.emptyItemText

filterItems()

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

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

Filters items by the filter value.

Parameters

items

ComboboxItem<any>[]

The items to filter.

Returns

ComboboxItem<any>[]

The filtered items.

Inherited from

ComboboxEditor.filterItems

findById()

protected findById<TElement>(id): TElement

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

Finds a child element by its prefix-relative id.

Type Parameters

Inherited from

ComboboxEditor.get_values

getCascadeFromValue()

protected getCascadeFromValue(parent): any

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

ComboboxEditor.getComboboxOptions

getCreateSearchChoice()

getCreateSearchChoice(getName): (s) => object

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

Returns a callback that creates a search choice for a term.

Parameters

getName

(z) => string

Optional callback to get the name of an item.

Returns

The search choice callback.

(s): object

Parameters

s

string

Returns

object

id

id: string

text

text: string

Inherited from

ComboboxEditor.getCreateSearchChoice

getCssClass()

protected getCssClass(): string

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

Returns the CSS class(es) applied to the widget's DOM node.

Returns

string

The space-separated CSS class string.

Inherited from

ComboboxEditor.getCssClass

getCustomAttribute()

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

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

Returns a custom attribute applied to the widget's type.

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

The attribute type to look up.

inherit

boolean = true

Whether to search inherited types; defaults to true.

Returns

TAttr

The matching attribute, or null.

Inherited from

ComboboxEditor.getCustomAttribute

getDialogType()

protected getDialogType(): DialogType | PromiseLike<DialogType>

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

Returns the dialog type used for in-place add.

Returns

DialogType | PromiseLike<DialogType>

The dialog type.

Inherited from

ComboboxEditor.getDialogType

getDialogTypeKey()

protected getDialogTypeKey(): string

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

Returns

string

Deprecated

Override getDialogType() instead

Inherited from

ComboboxEditor.getDialogTypeKey

getEditValue()

getEditValue(property, target): void

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

Gets the edit value into a target object.

Parameters

property

PropertyItem

The property item.

target

any

The target object.

Returns

void

Inherited from

ComboboxEditor.getEditValue

getGridField()

getGridField(): Fluent

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

Returns the closest .field element containing the widget's DOM node.

Returns

Fluent

A Fluent wrapper for the grid field.

Inherited from

ComboboxEditor.getGridField

getIdField()

protected getIdField(): any

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

Returns the id field name.

Returns

any

The id field.

Inherited from

ComboboxEditor.getIdField

getItems()

getItems(): any[]

Defined in: src/ui/editors/selecteditor.ts:27

Returns the items to display in the editor.

Returns

any[]

The list of items.

getPageSize()

protected getPageSize(): number

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

Returns the page size for paged searches.

Returns

number

The page size.

Inherited from

ComboboxEditor.getPageSize

getTextField()

protected getTextField(): any

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

Returns the text field name.

Returns

any

The text field.

Inherited from

ComboboxEditor.getTextField

getTypeDelay()

protected getTypeDelay(): any

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

Returns the type delay for searching.

Returns

any

The delay in milliseconds.

Inherited from

ComboboxEditor.getTypeDelay

hasAsyncSource()

protected hasAsyncSource(): boolean

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

Whether the editor has an asynchronous item source.

Returns

boolean

True when async.

Inherited from

ComboboxEditor.hasAsyncSource

init()

init(): this

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

Initializes the widget, rendering its contents if rendering was deferred.

Returns

this

This widget instance.

Inherited from

ComboboxEditor.init

initNewEntity()

protected initNewEntity(entity): void

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

Initializes a new entity with cascade/filter values.

Parameters

entity

ComboboxItem

The new entity.

Returns

void

Inherited from

ComboboxEditor.initNewEntity

inplaceCreateClick()

protected inplaceCreateClick(e): void

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

Handles the in-place create button click.

Parameters

e

Event

The click event.

Returns

void

Inherited from

ComboboxEditor.inplaceCreateClick

internalRenderContents()

internalRenderContents(): void

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

Renders the widget's contents and runs any queued after-render callbacks.

Returns

void

Inherited from

ComboboxEditor.internalRenderContents

isAutoComplete()

protected isAutoComplete(): boolean

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

Whether arbitrary values are allowed.

Returns

boolean

True when auto-complete is enabled.

Inherited from

ComboboxEditor.isAutoComplete

isMultiple()

protected isMultiple(): boolean

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

Whether multiple items can be selected.

Returns

boolean

True when multiple.

Inherited from

ComboboxEditor.isMultiple

itemDisabled()

protected itemDisabled(item): boolean

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

Whether an item is disabled.

Parameters

item

ComboboxItem

The item.

Returns

boolean

True when disabled.

Inherited from

ComboboxEditor.itemDisabled

itemId()

protected itemId(item): string

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

Returns the id of an item.

Parameters

item

ComboboxItem

The item.

Returns

string

The item id.

Inherited from

ComboboxEditor.itemId

itemText()

protected itemText(item): string

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

Returns the display text of an item.

Parameters

item

ComboboxItem

The item.

Returns

string

The item text.

Inherited from

ComboboxEditor.itemText

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Renders the widget from a legacy getTemplate string, if defined.

Returns

boolean

True if a legacy template was rendered.

Inherited from

ComboboxEditor.legacyTemplateRender

mapItem()

protected mapItem(item): ComboboxItem

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

Maps an item to a combobox item.

Parameters

item

ComboboxItem

The item.

Returns

ComboboxItem

The combobox item.

Inherited from

ComboboxEditor.mapItem

mapItems()

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

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

Maps a list of items to combobox items.

Parameters

items

ComboboxItem<any>[]

The items.

Returns

ComboboxItem<any>[]

The combobox items.

Inherited from

ComboboxEditor.mapItems

openDropdown()

openDropdown(): void

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

Opens the combobox dropdown.

Returns

void

Inherited from

ComboboxEditor.openDropdown

render()

render(): any

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

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

renderContents()

protected renderContents(): any

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

Renders the widget's contents. Override this to provide custom content.

Returns

any

The rendered contents.

Inherited from

ComboboxEditor.renderContents

set_cascadeField()

protected set_cascadeField(value): void

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

Sets the cascade field name.

Parameters

value

string

The cascade field.

Returns

void

Inherited from

ComboboxEditor.set_cascadeField

set_cascadeFrom()

protected set_cascadeFrom(value): void

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

Sets the cascade-from parent id.

Parameters

value

string

The parent id.

Returns

void

Inherited from

ComboboxEditor.set_cascadeFrom

set_cascadeValue()

protected set_cascadeValue(value): void

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

Sets the cascade value and refreshes items.

Parameters

value

any

The cascade value.

Returns

void

Inherited from

ComboboxEditor.set_cascadeValue

set_filterField()

protected set_filterField(value): void

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

Sets the filter field name.

Parameters

value

string

The filter field.

Returns

void

Inherited from

ComboboxEditor.set_filterField

set_filterValue()

protected set_filterValue(value): void

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

Sets the filter value and refreshes items.

Parameters

value

any

The filter value.

Returns

void

Inherited from

ComboboxEditor.set_filterValue

set_readOnly()

set_readOnly(value): void

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

Sets whether the editor is read-only.

Parameters

value

boolean

True to enable read-only mode.

Returns

void

Inherited from

ComboboxEditor.set_readOnly

set_value()

set_value(value): void

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

Sets the current value.

Parameters

value

string

The value to set.

Returns

void

Inherited from

ComboboxEditor.set_value

set_values()

protected set_values(value): void

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

Sets the current values.

Parameters

value

string[]

The values to set.

Returns

void

Inherited from

ComboboxEditor.set_values

setCascadeFrom()

protected setCascadeFrom(value): void

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

Sets the cascade-from parent id.

Parameters

value

string

The parent id.

Returns

void

Inherited from

ComboboxEditor.setCascadeFrom

setEditDialogReadOnly()

protected setEditDialogReadOnly(dialog): void

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

Sets the edit dialog to read-only.

Parameters

dialog

any

The dialog.

Returns

void

Inherited from

ComboboxEditor.setEditDialogReadOnly

setEditValue()

setEditValue(source, property): void

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

Sets the edit value from a source object.

Parameters

source

any

The source object.

property

PropertyItem

The property item.

Returns

void

Inherited from

ComboboxEditor.setEditValue

setTermOnNewEntity()

protected setTermOnNewEntity(entity, term, dialog): void

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

Sets the search term on a new entity.

Parameters

entity

ComboboxItem

The new entity.

term

string

The search term.

dialog

any

The edit dialog.

Returns

void

Inherited from

ComboboxEditor.setTermOnNewEntity

syncOrAsyncThen()

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

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

Runs a method synchronously or asynchronously depending on the widget's useAsync flag, then invokes a continuation.

Type Parameters

T

T

Parameters

syncMethod

() => T

The synchronous method to run.

asyncMethod

() => PromiseLike<T>

The asynchronous method to run.

then

(v) => void

The continuation invoked with the result.

Returns

void

Inherited from

ComboboxEditor.syncOrAsyncThen

updateItems()

updateItems(): void

Defined in: src/ui/editors/selecteditor.ts:45

Loads the configured items into the editor.

Returns

void

Overrides

ComboboxEditor.updateItems

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns an id prefix helper for resolving child element ids.

Returns

IdPrefixType

An IdPrefixType proxy for this widget's id prefix.

Inherited from

ComboboxEditor.useIdPrefix

useInplaceAdd()

protected useInplaceAdd(): boolean

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

Whether in-place add is enabled.

Returns

boolean

True when enabled.

Inherited from

ComboboxEditor.useInplaceAdd

create()

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

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

Creates a widget instance from the given params, appending its element to the container and invoking the init/init callbacks.

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

The widget creation params.

Returns

TWidget

The created widget instance.

Inherited from

ComboboxEditor.create

createDefaultElement()

static createDefaultElement(): HTMLInputElement

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

Creates the default hidden input element for the combobox.

Returns

HTMLInputElement

The hidden input element.

Inherited from

ComboboxEditor.createDefaultElement

filterByText()

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

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

Filters items by text, matching the term against the item text.

Type Parameters

TItem

TItem

Parameters

items

TItem[]

The items to filter.

getText

(item) => string

Callback that returns the text of an item.

term

string

The search term.

Returns

TItem[]

The filtered items.

Inherited from

ComboboxEditor.filterByText

getWidgetName()

static getWidgetName(type): string

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

Returns the widget name for a type, used for association and unique names.

Parameters

type

Function

The widget type.

Returns

string

The widget name.

Inherited from

ComboboxEditor.getWidgetName

registerClass()

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

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

Registers this type as a class with the given type name.

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

The type name to register.

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Optional interfaces and attributes.

Returns

ClassTypeInfo<TypeName>

The class type info.

Inherited from

ComboboxEditor.registerClass

registerEditor()

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

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

Registers this type as an editor with the given type name.

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

The type name to register.

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Optional interfaces and attributes.

Returns

EditorTypeInfo<TypeName>

The editor type info.

Inherited from

ComboboxEditor.registerEditor