Skip to content

@serenity-is/corelib / LookupEditor

Class: LookupEditor

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new LookupEditor(hidden, opt?)

Parameters

Name Type
hidden JQuery
opt? LookupEditorOptions

Overrides

LookupEditorBase.constructor

Defined in

src/ui/editors/lookupeditor.ts:148

Properties

• Protected cascadeLink: CascadedWidgetLink<Widget<any>>

Inherited from

LookupEditorBase.cascadeLink

Defined in

src/ui/editors/select2editor.ts:701


element

• element: JQuery

Inherited from

LookupEditorBase.element

Defined in

src/ui/widgets/widget.ts:61


idPrefix

• Readonly idPrefix: string

Inherited from

LookupEditorBase.idPrefix

Defined in

src/ui/widgets/widget.ts:65


lastCreateTerm

• Protected lastCreateTerm: string

Inherited from

LookupEditorBase.lastCreateTerm

Defined in

src/ui/editors/select2editor.ts:64


lookup

• Protected lookup: Lookup<any>

Inherited from

LookupEditorBase.lookup

Defined in

src/ui/editors/lookupeditor.ts:56


onInitNewEntity

• onInitNewEntity: (entity: any) => void

Type declaration

▸ (entity): void

Parameters
Name Type
entity any
Returns

void

Inherited from

LookupEditorBase.onInitNewEntity

Defined in

src/ui/editors/select2editor.ts:871


openDialogAsPanel

• openDialogAsPanel: boolean

Inherited from

LookupEditorBase.openDialogAsPanel

Defined in

src/ui/editors/select2editor.ts:972


options

• Protected options: LookupEditorOptions

Inherited from

LookupEditorBase.options

Defined in

src/ui/widgets/widget.ts:62


uniqueName

• Protected uniqueName: string

Inherited from

LookupEditorBase.uniqueName

Defined in

src/ui/widgets/widget.ts:64


widgetName

• Protected widgetName: string

Inherited from

LookupEditorBase.widgetName

Defined in

src/ui/widgets/widget.ts:63

Accessors

cascadeField

• get cascadeField(): string

Returns

string

Inherited from

LookupEditorBase.cascadeField

Defined in

src/ui/editors/select2editor.ts:745

• set cascadeField(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

LookupEditorBase.cascadeField

Defined in

src/ui/editors/select2editor.ts:753


cascadeFrom

• get cascadeFrom(): string

Returns

string

Inherited from

LookupEditorBase.cascadeFrom

Defined in

src/ui/editors/select2editor.ts:726

• set cascadeFrom(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

LookupEditorBase.cascadeFrom

Defined in

src/ui/editors/select2editor.ts:737


cascadeValue

• get cascadeValue(): any

Returns

any

Inherited from

LookupEditorBase.cascadeValue

Defined in

src/ui/editors/select2editor.ts:761

• set cascadeValue(value): void

Parameters

Name Type
value any

Returns

void

Inherited from

LookupEditorBase.cascadeValue

Defined in

src/ui/editors/select2editor.ts:773


filterField

• get filterField(): string

Returns

string

Inherited from

LookupEditorBase.filterField

Defined in

src/ui/editors/select2editor.ts:781

• set filterField(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

LookupEditorBase.filterField

Defined in

src/ui/editors/select2editor.ts:789


filterValue

• get filterValue(): any

Returns

any

Inherited from

LookupEditorBase.filterValue

Defined in

src/ui/editors/select2editor.ts:797

• set filterValue(value): void

Parameters

Name Type
value any

Returns

void

Inherited from

LookupEditorBase.filterValue

Defined in

src/ui/editors/select2editor.ts:809


itemById

• Protected get itemById(): Object

Returns

Object

Inherited from

LookupEditorBase.itemById

Defined in

src/ui/editors/select2editor.ts:349

• Protected set itemById(value): void

Parameters

Name Type
value Object

Returns

void

Inherited from

LookupEditorBase.itemById

Defined in

src/ui/editors/select2editor.ts:356


items

• get items(): Select2Item[]

Returns

Select2Item[]

Inherited from

LookupEditorBase.items

Defined in

src/ui/editors/select2editor.ts:332

• set items(value): void

Parameters

Name Type
value Select2Item[]

Returns

void

Inherited from

LookupEditorBase.items

Defined in

src/ui/editors/select2editor.ts:339


readOnly

• get readOnly(): boolean

Returns

boolean

Inherited from

LookupEditorBase.readOnly

Defined in

src/ui/editors/select2editor.ts:672

• set readOnly(value): void

Parameters

Name Type
value boolean

Returns

void

Inherited from

LookupEditorBase.readOnly

Defined in

src/ui/editors/select2editor.ts:693


selectedItem

• get selectedItem(): TItem

Returns

TItem

Inherited from

LookupEditorBase.selectedItem

Defined in

src/ui/editors/select2editor.ts:598


selectedItems

• get selectedItems(): TItem[]

Returns

TItem[]

Inherited from

LookupEditorBase.selectedItems

Defined in

src/ui/editors/select2editor.ts:608


text

• get text(): string

Returns

string

Inherited from

LookupEditorBase.text

Defined in

src/ui/editors/select2editor.ts:664


value

• get value(): string

Returns

string

Inherited from

LookupEditorBase.value

Defined in

src/ui/editors/select2editor.ts:565

• set value(v): void

Parameters

Name Type
v string

Returns

void

Inherited from

LookupEditorBase.value

Defined in

src/ui/editors/select2editor.ts:594


values

• get values(): string[]

Returns

string[]

Inherited from

LookupEditorBase.values

Defined in

src/ui/editors/select2editor.ts:642

• set values(value): void

Parameters

Name Type
value string[]

Returns

void

Inherited from

LookupEditorBase.values

Defined in

src/ui/editors/select2editor.ts:656

Methods

abortPendingQuery

▸ Protected abortPendingQuery(): void

Returns

void

Inherited from

LookupEditorBase.abortPendingQuery

Defined in

src/ui/editors/select2editor.ts:175


addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

LookupEditorBase.addCssClass

Defined in

src/ui/widgets/widget.ts:100


addInplaceCreate

▸ Protected addInplaceCreate(addTitle, editTitle): void

Parameters

Name Type
addTitle string
editTitle string

Returns

void

Inherited from

LookupEditorBase.addInplaceCreate

Defined in

src/ui/editors/select2editor.ts:388


addItem

▸ addItem(item): void

Parameters

Name Type
item Select2Item

Returns

void

Inherited from

LookupEditorBase.addItem

Defined in

src/ui/editors/select2editor.ts:371


addOption

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

Parameters

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

Returns

void

Inherited from

LookupEditorBase.addOption

Defined in

src/ui/editors/select2editor.ts:379


addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

Name Type
eventClass string
rule (p1: JQuery) => string

Returns

JQuery

Inherited from

LookupEditorBase.addValidationRule

Defined in

src/ui/widgets/widget.ts:134


allowClear

▸ Protected allowClear(): boolean

Returns

boolean

Inherited from

LookupEditorBase.allowClear

Defined in

src/ui/editors/select2editor.ts:162


asyncSearch

▸ Protected asyncSearch(query, results): Select2SearchPromise

Parameters

Name Type
query Select2SearchQuery
results (result: Select2SearchResult<any>) => void

Returns

Select2SearchPromise

Inherited from

LookupEditorBase.asyncSearch

Defined in

src/ui/editors/lookupeditor.ts:106


cascadeItems

▸ Protected cascadeItems(items): any[]

Parameters

Name Type
items any[]

Returns

any[]

Inherited from

LookupEditorBase.cascadeItems

Defined in

src/ui/editors/select2editor.ts:813


change

▸ change(handler): void

Parameters

Name Type
handler (e: JQueryEventObject) => void

Returns

void

Inherited from

LookupEditorBase.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name Type
handler (e: JQueryEventObject) => void

Returns

void

Inherited from

LookupEditorBase.change

Defined in

src/ui/widgets/widget.ts:259


changeSelect2

▸ changeSelect2(handler): void

Parameters

Name Type
handler (e: JQueryEventObject) => void

Returns

void

Inherited from

LookupEditorBase.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name Type
handler (e: JQueryEventObject) => void

Returns

void

Inherited from

LookupEditorBase.changeSelect2

Defined in

src/ui/widgets/widget.ts:260


clearItems

▸ clearItems(): void

Returns

void

Inherited from

LookupEditorBase.clearItems

Defined in

src/ui/editors/select2editor.ts:363


createEditDialog

▸ Protected createEditDialog(callback): void

Parameters

Name Type
callback (dlg: IEditDialog) => void

Returns

void

Inherited from

LookupEditorBase.createEditDialog

Defined in

src/ui/editors/select2editor.ts:862


destroy

▸ destroy(): void

Returns

void

Inherited from

LookupEditorBase.destroy

Defined in

src/ui/editors/lookupeditor.ts:30


editDialogDataChange

▸ Protected editDialogDataChange(): void

Returns

void

Inherited from

LookupEditorBase.editDialogDataChange

Defined in

src/ui/editors/lookupeditor.ts:141


emptyItemText

▸ Protected emptyItemText(): string

Returns

string

Inherited from

LookupEditorBase.emptyItemText

Defined in

src/ui/editors/select2editor.ts:114


filterItems

▸ Protected filterItems(items): any[]

Parameters

Name Type
items any[]

Returns

any[]

Inherited from

LookupEditorBase.filterItems

Defined in

src/ui/editors/select2editor.ts:835


getCascadeFromValue

▸ Protected getCascadeFromValue(parent): any

Parameters

Name Type
parent Widget<any>

Returns

any

Inherited from

LookupEditorBase.getCascadeFromValue

Defined in

src/ui/editors/select2editor.ts:697


getCreateSearchChoice

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

Parameters

Name Type
getName (z: any) => string

Returns

fn

▸ (s): Object

Parameters
Name Type
s string
Returns

Object

Name Type
id string
text string

Inherited from

LookupEditorBase.getCreateSearchChoice

Defined in

src/ui/editors/select2editor.ts:450


getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

LookupEditorBase.getCssClass

Defined in

src/ui/widgets/widget.ts:104


getDialogTypeKey

▸ Protected getDialogTypeKey(): string

Returns

string

Inherited from

LookupEditorBase.getDialogTypeKey

Defined in

src/ui/editors/lookupeditor.ts:129


getEditValue

▸ getEditValue(property, target): void

Parameters

Name Type
property PropertyItem
target any

Returns

void

Inherited from

LookupEditorBase.getEditValue

Defined in

src/ui/editors/select2editor.ts:508


getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

LookupEditorBase.getGridField

Defined in

src/ui/widgets/widget.ts:138


getIdField

▸ Protected getIdField(): any

Returns

any

Inherited from

LookupEditorBase.getIdField

Defined in

src/ui/editors/lookupeditor.ts:70


getItemDisabled

▸ Protected getItemDisabled(item, lookup): boolean

Parameters

Name Type
item any
lookup Lookup<any>

Returns

boolean

Inherited from

LookupEditorBase.getItemDisabled

Defined in

src/ui/editors/lookupeditor.ts:91


getItemText

▸ Protected getItemText(item, lookup): any

Parameters

Name Type
item any
lookup Lookup<any>

Returns

any

Inherited from

LookupEditorBase.getItemText

Defined in

src/ui/editors/lookupeditor.ts:74


getItems

▸ Protected getItems(lookup): any[]

Parameters

Name Type
lookup Lookup<any>

Returns

any[]

Inherited from

LookupEditorBase.getItems

Defined in

src/ui/editors/lookupeditor.ts:66


getLookup

▸ Protected getLookup(): Lookup<any>

Returns

Lookup<any>

Inherited from

LookupEditorBase.getLookup

Defined in

src/ui/editors/lookupeditor.ts:62


getLookupAsync

▸ Protected getLookupAsync(): PromiseLike<Lookup<any>>

Returns

PromiseLike<Lookup<any>>

Inherited from

LookupEditorBase.getLookupAsync

Defined in

src/ui/editors/lookupeditor.ts:58


getLookupKey

▸ Protected getLookupKey(): string

Returns

string

Inherited from

LookupEditorBase.getLookupKey

Defined in

src/ui/editors/lookupeditor.ts:37


getPageSize

▸ Protected getPageSize(): number

Returns

number

Inherited from

LookupEditorBase.getPageSize

Defined in

src/ui/editors/select2editor.ts:119


getSelect2Options

▸ Protected getSelect2Options(): Select2Options

Returns

Select2Options

Inherited from

LookupEditorBase.getSelect2Options

Defined in

src/ui/editors/select2editor.ts:184


getTextField

▸ Protected getTextField(): any

Returns

any

Inherited from

LookupEditorBase.getTextField

Defined in

src/ui/editors/select2editor.ts:134


getTypeDelay

▸ Protected getTypeDelay(): any

Returns

any

Inherited from

LookupEditorBase.getTypeDelay

Defined in

src/ui/editors/select2editor.ts:110


get_cascadeField

▸ Protected get_cascadeField(): string

Returns

string

Inherited from

LookupEditorBase.get_cascadeField

Defined in

src/ui/editors/select2editor.ts:741


get_cascadeFrom

▸ Protected get_cascadeFrom(): string

Returns

string

Inherited from

LookupEditorBase.get_cascadeFrom

Defined in

src/ui/editors/select2editor.ts:722


get_cascadeValue

▸ Protected get_cascadeValue(): any

Returns

any

Inherited from

LookupEditorBase.get_cascadeValue

Defined in

src/ui/editors/select2editor.ts:757


get_delimited

▸ get_delimited(): boolean

Returns

boolean

Inherited from

LookupEditorBase.get_delimited

Defined in

src/ui/editors/select2editor.ts:328


get_filterField

▸ Protected get_filterField(): string

Returns

string

Inherited from

LookupEditorBase.get_filterField

Defined in

src/ui/editors/select2editor.ts:777


get_filterValue

▸ Protected get_filterValue(): any

Returns

any

Inherited from

LookupEditorBase.get_filterValue

Defined in

src/ui/editors/select2editor.ts:793


get_itemByKey

▸ Protected get_itemByKey(): Object

Returns

Object

Inherited from

LookupEditorBase.get_itemByKey

Defined in

src/ui/editors/select2editor.ts:525


get_items

▸ Protected get_items(): Select2Item[]

Returns

Select2Item[]

Inherited from

LookupEditorBase.get_items

Defined in

src/ui/editors/select2editor.ts:521


get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Inherited from

LookupEditorBase.get_readOnly

Defined in

src/ui/editors/select2editor.ts:668


get_select2Container

▸ Protected get_select2Container(): JQuery

Returns

JQuery

Inherited from

LookupEditorBase.get_select2Container

Defined in

src/ui/editors/select2editor.ts:517


get_text

▸ Protected get_text(): string

Returns

string

Inherited from

LookupEditorBase.get_text

Defined in

src/ui/editors/select2editor.ts:660


get_value

▸ get_value(): any

Returns

any

Inherited from

LookupEditorBase.get_value

Defined in

src/ui/editors/select2editor.ts:551


get_values

▸ Protected get_values(): string[]

Returns

string[]

Inherited from

LookupEditorBase.get_values

Defined in

src/ui/editors/select2editor.ts:623


hasAsyncSource

▸ hasAsyncSource(): boolean

Returns

boolean

Inherited from

LookupEditorBase.hasAsyncSource

Defined in

src/ui/editors/lookupeditor.ts:26


init

▸ init(action?): LookupEditor

Parameters

Name Type
action? (widget: any) => void

Returns

LookupEditor

Inherited from

LookupEditorBase.init

Defined in

src/ui/widgets/widget.ts:179


initNewEntity

▸ Protected initNewEntity(entity): void

Parameters

Name Type
entity any

Returns

void

Inherited from

LookupEditorBase.initNewEntity

Defined in

src/ui/editors/select2editor.ts:873


initialize

▸ initialize(): void

Returns

void

Inherited from

LookupEditorBase.initialize

Defined in

src/ui/widgets/widget.ts:176


inplaceCreateClick

▸ Protected inplaceCreateClick(e): void

Parameters

Name Type
e JQueryEventObject

Returns

void

Inherited from

LookupEditorBase.inplaceCreateClick

Defined in

src/ui/editors/select2editor.ts:901


isAutoComplete

▸ Protected isAutoComplete(): boolean

Returns

boolean

Inherited from

LookupEditorBase.isAutoComplete

Defined in

src/ui/editors/select2editor.ts:446


isMultiple

▸ Protected isMultiple(): boolean

Returns

boolean

Inherited from

LookupEditorBase.isMultiple

Defined in

src/ui/editors/select2editor.ts:167


itemDisabled

▸ Protected itemDisabled(item): boolean

Parameters

Name Type
item any

Returns

boolean

Inherited from

LookupEditorBase.itemDisabled

Defined in

src/ui/editors/select2editor.ts:145


itemId

▸ Protected itemId(item): string

Parameters

Name Type
item any

Returns

string

Inherited from

LookupEditorBase.itemId

Defined in

src/ui/editors/select2editor.ts:127


itemText

▸ Protected itemText(item): string

Parameters

Name Type
item any

Returns

string

Inherited from

LookupEditorBase.itemText

Defined in

src/ui/editors/select2editor.ts:138


mapItem

▸ Protected mapItem(item): Select2Item

Parameters

Name Type
item any

Returns

Select2Item

Inherited from

LookupEditorBase.mapItem

Defined in

src/ui/editors/lookupeditor.ts:82


mapItems

▸ Protected mapItems(items): Select2Item[]

Parameters

Name Type
items any[]

Returns

Select2Item[]

Inherited from

LookupEditorBase.mapItems

Defined in

src/ui/editors/select2editor.ts:158


renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

LookupEditorBase.renderContents

Defined in

src/ui/widgets/widget.ts:184


setCascadeFrom

▸ Protected setCascadeFrom(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

LookupEditorBase.setCascadeFrom

Defined in

src/ui/editors/select2editor.ts:703


setCreateTermOnNewEntity

▸ Protected setCreateTermOnNewEntity(entity, term): void

Parameters

Name Type
entity any
term string

Returns

void

Inherited from

LookupEditorBase.setCreateTermOnNewEntity

Defined in

src/ui/editors/lookupeditor.ts:137


setEditDialogReadOnly

▸ Protected setEditDialogReadOnly(dialog): void

Parameters

Name Type
dialog any

Returns

void

Inherited from

LookupEditorBase.setEditDialogReadOnly

Defined in

src/ui/editors/select2editor.ts:887


setEditValue

▸ setEditValue(source, property): void

Parameters

Name Type
source any
property PropertyItem

Returns

void

Inherited from

LookupEditorBase.setEditValue

Defined in

src/ui/editors/select2editor.ts:498


setTermOnNewEntity

▸ Protected setTermOnNewEntity(entity, term): void

Parameters

Name Type
entity any
term string

Returns

void

Inherited from

LookupEditorBase.setTermOnNewEntity

Defined in

src/ui/editors/select2editor.ts:898


set_cascadeField

▸ Protected set_cascadeField(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

LookupEditorBase.set_cascadeField

Defined in

src/ui/editors/select2editor.ts:749


set_cascadeFrom

▸ Protected set_cascadeFrom(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

LookupEditorBase.set_cascadeFrom

Defined in

src/ui/editors/select2editor.ts:730


set_cascadeValue

▸ Protected set_cascadeValue(value): void

Parameters

Name Type
value any

Returns

void

Inherited from

LookupEditorBase.set_cascadeValue

Defined in

src/ui/editors/select2editor.ts:765


set_filterField

▸ Protected set_filterField(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

LookupEditorBase.set_filterField

Defined in

src/ui/editors/select2editor.ts:785


set_filterValue

▸ Protected set_filterValue(value): void

Parameters

Name Type
value any

Returns

void

Inherited from

LookupEditorBase.set_filterValue

Defined in

src/ui/editors/select2editor.ts:801


set_readOnly

▸ set_readOnly(value): void

Parameters

Name Type
value boolean

Returns

void

Inherited from

LookupEditorBase.set_readOnly

Defined in

src/ui/editors/select2editor.ts:686


set_value

▸ set_value(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

LookupEditorBase.set_value

Defined in

src/ui/editors/select2editor.ts:569


set_values

▸ Protected set_values(value): void

Parameters

Name Type
value string[]

Returns

void

Inherited from

LookupEditorBase.set_values

Defined in

src/ui/editors/select2editor.ts:646


updateItems

▸ updateItems(): void

Returns

void

Inherited from

LookupEditorBase.updateItems

Defined in

src/ui/editors/lookupeditor.ts:95


useInplaceAdd

▸ Protected useInplaceAdd(): boolean

Returns

boolean

Inherited from

LookupEditorBase.useInplaceAdd

Defined in

src/ui/editors/select2editor.ts:439


create

▸ Static create<TWidget, TOpt>(params): TWidget

Type parameters

Name Type
TWidget extends Widget<TOpt, TWidget>
TOpt TOpt

Parameters

Name Type
params CreateWidgetParams<TWidget, TOpt>

Returns

TWidget

Inherited from

LookupEditorBase.create

Defined in

src/ui/widgets/widget.ts:153


elementFor

▸ Static elementFor<TWidget>(editorType): JQuery

Type parameters

Name
TWidget

Parameters

Name Type
editorType (...args: any[]) => TWidget

Returns

JQuery

Inherited from

LookupEditorBase.elementFor

Defined in

src/ui/widgets/widget.ts:128


filterByText

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

Type parameters

Name
TItem

Parameters

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

Returns

TItem[]

Inherited from

LookupEditorBase.filterByText

Defined in

src/ui/editors/select2editor.ts:529


getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name Type
type Function

Returns

string

Inherited from

LookupEditorBase.getWidgetName

Defined in

src/ui/widgets/widget.ts:124