@serenity-is/corelib / LookupEditor

Class: LookupEditor<P>

Defined in: src/ui/editors/lookupeditor.ts:228

An editor that renders a combobox over lookup items.

Extends

• LookupEditorBase<P, { }>

Type Parameters

P

P extends LookupEditorOptions = LookupEditorOptions

Widget props type.

Constructors

Constructor

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

Defined in: src/ui/editors/lookupeditor.ts:236

Creates a lookup editor.

Parameters

props

EditorProps<P>

Widget props.

Returns

LookupEditor<P>

Overrides

LookupEditorBase.constructor

Properties

cascadeLink

protected cascadeLink: CascadedWidgetLink<Widget<any>>

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

Inherited from

LookupEditorBase.cascadeLink

---

domNode

readonly domNode: HTMLInputElement

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

The hidden input element that backs the combobox editor.

Inherited from

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

LookupEditorBase.idPrefix

---

lastCreateTerm

protected lastCreateTerm: string

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

Inherited from

LookupEditorBase.lastCreateTerm

---

lookup

protected lookup: Lookup<{ }>

Defined in: src/ui/editors/lookupeditor.ts:85

Inherited from

LookupEditorBase.lookup

---

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

Returns

void

Inherited from

LookupEditorBase.onInitNewEntity

---

openDialogAsPanel

openDialogAsPanel: boolean

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

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

Inherited from

LookupEditorBase.openDialogAsPanel

---

options

protected readonly options: WidgetProps<EditorProps<P>>

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

The widget's options/props.

Inherited from

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

LookupEditorBase.uniqueName

---

[typeInfo]

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

Defined in: src/ui/editors/lookupeditor.ts:230

Overrides

LookupEditorBase.[typeInfo]

---

isComponent

readonly static isComponent: true = true

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

Inherited from

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

LookupEditorBase.values

Methods

abortPendingQuery()

protected abortPendingQuery(): void

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

Aborts any pending search query.

Returns

void

Inherited from

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

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

LookupEditorBase.addInplaceCreate

---

addItem()

addItem(item): void

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

Adds an item to the editor.

Parameters

item

ComboboxItem<{ }>

The item to add.

Returns

void

Inherited from

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

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

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

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

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

LookupEditorBase.allowClear

---

asyncSearch()

protected asyncSearch(query): Promise<ComboboxSearchResult<{ }>>

Defined in: src/ui/editors/lookupeditor.ts:177

Performs an asynchronous search over the lookup items.

Parameters

query

ComboboxSearchQuery

The search query.

Returns

Promise<ComboboxSearchResult<{ }>>

A promise resolving to the search result.

Inherited from

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

LookupEditorBase.byId

---

cascadeItems()

protected cascadeItems(items): object[]

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

Filters items by the cascade value.

Parameters

items

object[]

The items to filter.

Returns

object[]

The filtered items.

Inherited from

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

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

LookupEditorBase.changeSelect2

---

clearItems()

clearItems(): void

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

Clears all items from the editor.

Returns

void

Inherited from

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

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

LookupEditorBase.deferRender

---

destroy()

destroy(): void

Defined in: src/ui/editors/lookupeditor.ts:53

Cleans up the lookup change subscription.

Returns

void

Inherited from

LookupEditorBase.destroy

---

editDialogDataChange()

protected editDialogDataChange(): void

Defined in: src/ui/editors/lookupeditor.ts:219

Reloads the lookup when the edit dialog data changes.

Returns

void

Inherited from

LookupEditorBase.editDialogDataChange

---

emptyItemText()

protected emptyItemText(): string

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

Returns the text for the empty item.

Returns

string

The empty item text.

Inherited from

LookupEditorBase.emptyItemText

---

filterItems()

protected filterItems(items): object[]

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

Filters items by the filter value.

Parameters

items

object[]

The items to filter.

Returns

object[]

The filtered items.

Inherited from

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

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

The id relative to the widget's id prefix.

Returns

TElement

The matching element, or null if not found.

Inherited from

LookupEditorBase.findById

---

get_cascadeField()

protected get_cascadeField(): string

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

Returns the cascade field name.

Returns

string

The cascade field.

Inherited from

LookupEditorBase.get_cascadeField

---

get_cascadeFrom()

protected get_cascadeFrom(): string

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

Returns the cascade-from parent id.

Returns

string

The parent id.

Inherited from

LookupEditorBase.get_cascadeFrom

---

get_cascadeValue()

protected get_cascadeValue(): any

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

Returns the cascade value.

Returns

any

The cascade value.

Inherited from

LookupEditorBase.get_cascadeValue

---

get_delimited()

get_delimited(): boolean

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

Returns whether the value is delimited.

Returns

boolean

True when delimited.

Inherited from

LookupEditorBase.get_delimited

---

get_filterField()

protected get_filterField(): string

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

Returns the filter field name.

Returns

string

The filter field.

Inherited from

LookupEditorBase.get_filterField

---

get_filterValue()

protected get_filterValue(): any

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

Returns the filter value.

Returns

any

The filter value.

Inherited from

LookupEditorBase.get_filterValue

---

get_itemByKey()

protected get_itemByKey(): object

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

Returns the item-by-id map.

Returns

object

The item map.

Inherited from

LookupEditorBase.get_itemByKey

---

get_items()

protected get_items(): ComboboxItem<{ }>[]

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

Returns the items in the editor.

Returns

ComboboxItem<{ }>[]

The items.

Inherited from

LookupEditorBase.get_items

---

get_readOnly()

get_readOnly(): boolean

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

Returns whether the editor is read-only.

Returns

boolean

True when read-only.

Inherited from

LookupEditorBase.get_readOnly

---

get_text()

protected get_text(): string

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

Returns the display text of the current selection.

Returns

string

The text.

Inherited from

LookupEditorBase.get_text

---

get_value()

get_value(): string

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

Returns the current value.

Returns

string

The value.

Inherited from

LookupEditorBase.get_value

---

get_values()

protected get_values(): string[]

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

Returns the current values.

Returns

string[]

The values.

Inherited from

LookupEditorBase.get_values

---

getCascadeFromValue()

protected getCascadeFromValue(parent): any

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

Returns the cascade value from a parent widget.

Parameters

parent

Widget<any>

The parent widget.

Returns

any

The cascade value.

Inherited from

LookupEditorBase.getCascadeFromValue

---

getComboboxContainer()

protected getComboboxContainer(): HTMLElement

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

Returns the combobox container element.

Returns

HTMLElement

The container element.

Inherited from

LookupEditorBase.getComboboxContainer

---

getComboboxOptions()

protected getComboboxOptions(): ComboboxOptions

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

Returns the combobox options for this editor.

Returns

ComboboxOptions

Combobox options.

Inherited from

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

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

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

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

LookupEditorBase.getDialogType

---

getDialogTypeKey()

protected getDialogTypeKey(): string

Defined in: src/ui/editors/lookupeditor.ts:199

Returns the dialog type key for in-place add.

Returns

string

The dialog type key.

Inherited from

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

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

LookupEditorBase.getGridField

---

getIdField()

protected getIdField(): any

Defined in: src/ui/editors/lookupeditor.ts:116

Returns the id field name.

Returns

any

The id field.

Inherited from

LookupEditorBase.getIdField

---

getItemDisabled()

protected getItemDisabled(item, lookup): boolean

Defined in: src/ui/editors/lookupeditor.ts:154

Whether an item is disabled.

Parameters

item

The item.

lookup

Lookup<{ }>

The lookup.

Returns

boolean

True when disabled.

Inherited from

LookupEditorBase.getItemDisabled

---

getItems()

protected getItems(lookup): object[]

Defined in: src/ui/editors/lookupeditor.ts:108

Returns the items for the given lookup, filtered by cascade/filter values.

Parameters

lookup

Lookup<{ }>

The lookup.

Returns

object[]

The items.

Inherited from

LookupEditorBase.getItems

---

getItemText()

protected getItemText(item, lookup): any

Defined in: src/ui/editors/lookupeditor.ts:126

Returns the display text of an item.

Parameters

item

The item.

lookup

Lookup<{ }>

The lookup.

Returns

any

The item text.

Inherited from

LookupEditorBase.getItemText

---

getLookup()

protected getLookup(): Lookup<{ }>

Defined in: src/ui/editors/lookupeditor.ts:99

Returns the lookup synchronously.

Returns

Lookup<{ }>

The lookup.

Inherited from

LookupEditorBase.getLookup

---

getLookupAsync()

protected getLookupAsync(): PromiseLike<Lookup<{ }>>

Defined in: src/ui/editors/lookupeditor.ts:91

Asynchronously loads the lookup.

Returns

PromiseLike<Lookup<{ }>>

A promise resolving to the lookup.

Inherited from

LookupEditorBase.getLookupAsync

---

getLookupKey()

protected getLookupKey(): string

Defined in: src/ui/editors/lookupeditor.ts:66

Returns the lookup key for this editor.

Returns

string

The lookup key.

Inherited from

LookupEditorBase.getLookupKey

---

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

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

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

LookupEditorBase.getTypeDelay

---

hasAsyncSource()

hasAsyncSource(): boolean

Defined in: src/ui/editors/lookupeditor.ts:46

Whether the editor has an asynchronous item source.

Returns

boolean

True when async.

Inherited from

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

LookupEditorBase.init

---

initNewEntity()

protected initNewEntity(entity): void

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

Initializes a new entity with cascade/filter values.

Parameters

entity

The new entity.

Returns

void

Inherited from

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

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

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

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

LookupEditorBase.isMultiple

---

itemDisabled()

protected itemDisabled(item): boolean

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

Whether an item is disabled.

Parameters

item

The item.

Returns

boolean

True when disabled.

Inherited from

LookupEditorBase.itemDisabled

---

itemId()

protected itemId(item): string

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

Returns the id of an item.

Parameters

item

The item.

Returns

string

The item id.

Inherited from

LookupEditorBase.itemId

---

itemText()

protected itemText(item): string

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

Returns the display text of an item.

Parameters

item

The item.

Returns

string

The item text.

Inherited from

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

LookupEditorBase.legacyTemplateRender

---

mapItem()

protected mapItem(item): ComboboxItem<{ }>

Defined in: src/ui/editors/lookupeditor.ts:139

Maps an item to a combobox item.

Parameters

item

The item.

Returns

ComboboxItem<{ }>

The combobox item.

Inherited from

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

object[]

The items.

Returns

ComboboxItem<any>[]

The combobox items.

Inherited from

LookupEditorBase.mapItems

---

openDropdown()

openDropdown(): void

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

Opens the combobox dropdown.

Returns

void

Inherited from

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

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

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

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

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

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

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

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

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

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

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

LookupEditorBase.setCascadeFrom

---

setCreateTermOnNewEntity()

protected setCreateTermOnNewEntity(entity, term): void

Defined in: src/ui/editors/lookupeditor.ts:212

Sets the search term on a new entity.

Parameters

entity

The new entity.

term

string

The search term.

Returns

void

Inherited from

LookupEditorBase.setCreateTermOnNewEntity

---

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

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

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

The new entity.

term

string

The search term.

dialog

any

The edit dialog.

Returns

void

Inherited from

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

LookupEditorBase.syncOrAsyncThen

---

updateItems()

updateItems(): void

Defined in: src/ui/editors/lookupeditor.ts:161

Loads the lookup items into the editor.

Returns

void

Inherited from

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

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

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

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

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

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

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

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

LookupEditorBase.registerEditor