@serenity-is/corelib / Select2Editor

Class: Select2Editor<TOptions, TItem>

Type parameters

Name
TOptions
TItem

Hierarchy

• Widget<TOptions>

  ↳ Select2Editor

  ↳↳ SelectEditor

  ↳↳ EnumEditor

  ↳↳ LookupEditorBase

  ↳↳ ServiceLookupEditorBase

Implements

• ISetEditValue
• IGetEditValue
• IStringValue
• IReadOnly

Table of contents

Constructors

• constructor

Properties

• _itemById
• _items
• cascadeLink
• element
• idPrefix
• initSelectionPromise
• lastCreateTerm
• onInitNewEntity
• openDialogAsPanel
• options
• queryPromise
• typeTimeout
• uniqueName
• widgetName

Accessors

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

Methods

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

Constructors

constructor

• new Select2Editor<TOptions, TItem>(hidden, opt?)

Type parameters

Name
TOptions
TItem

Parameters

Name	Type
hidden	JQuery
opt?	any

Overrides

Widget.constructor

Defined in

src/ui/editors/select2editor.ts:66

Properties

_itemById

• Private _itemById: Object

Index signature

▪ [key: string]: Select2Item

Defined in

src/ui/editors/select2editor.ts:63

---

_items

• Private _items: Select2Item[]

Defined in

src/ui/editors/select2editor.ts:62

---

cascadeLink

• Protected cascadeLink: CascadedWidgetLink<Widget<any>>

Defined in

src/ui/editors/select2editor.ts:701

---

element

• element: JQuery

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

initSelectionPromise

• Private initSelectionPromise: Select2SearchPromise

Defined in

src/ui/editors/select2editor.ts:171

---

lastCreateTerm

• Protected lastCreateTerm: string

Defined in

src/ui/editors/select2editor.ts:64

---

onInitNewEntity

• onInitNewEntity: (entity: TItem) => void

Type declaration

▸ (entity): void

Parameters

Name	Type
entity	TItem

Returns

void

Defined in

src/ui/editors/select2editor.ts:871

---

openDialogAsPanel

• openDialogAsPanel: boolean

Defined in

src/ui/editors/select2editor.ts:972

---

options

• Protected options: TOptions

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:62

---

queryPromise

• Private queryPromise: Select2SearchPromise

Defined in

src/ui/editors/select2editor.ts:172

---

typeTimeout

• Private typeTimeout: number

Defined in

src/ui/editors/select2editor.ts:173

---

uniqueName

• Protected uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

widgetName

• Protected widgetName: string

Inherited from

Widget.widgetName

Defined in

src/ui/widgets/widget.ts:63

Accessors

cascadeField

• get cascadeField(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:745

• set cascadeField(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:753

---

cascadeFrom

• get cascadeFrom(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:726

• set cascadeFrom(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:737

---

cascadeValue

• get cascadeValue(): any

Returns

any

Defined in

src/ui/editors/select2editor.ts:761

• set cascadeValue(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/editors/select2editor.ts:773

---

filterField

• get filterField(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:781

• set filterField(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:789

---

filterValue

• get filterValue(): any

Returns

any

Defined in

src/ui/editors/select2editor.ts:797

• set filterValue(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/editors/select2editor.ts:809

---

itemById

• Protected get itemById(): Object

Returns

Object

Defined in

src/ui/editors/select2editor.ts:349

• Protected set itemById(value): void

Parameters

Name	Type
value	Object

Returns

void

Defined in

src/ui/editors/select2editor.ts:356

---

items

• get items(): Select2Item[]

Returns

Select2Item[]

Defined in

src/ui/editors/select2editor.ts:332

• set items(value): void

Parameters

Name	Type
value	Select2Item[]

Returns

void

Defined in

src/ui/editors/select2editor.ts:339

---

readOnly

• get readOnly(): boolean

Returns

boolean

Defined in

src/ui/editors/select2editor.ts:672

• set readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/editors/select2editor.ts:693

---

selectedItem

• get selectedItem(): TItem

Returns

TItem

Defined in

src/ui/editors/select2editor.ts:598

---

selectedItems

• get selectedItems(): TItem[]

Returns

TItem[]

Defined in

src/ui/editors/select2editor.ts:608

---

text

• get text(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:664

---

value

• get value(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:565

• set value(v): void

Parameters

Name	Type
v	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:594

---

values

• get values(): string[]

Returns

string[]

Defined in

src/ui/editors/select2editor.ts:642

• set values(value): void

Parameters

Name	Type
value	string[]

Returns

void

Defined in

src/ui/editors/select2editor.ts:656

Methods

abortPendingQuery

▸ Protected abortPendingQuery(): void

Returns

void

Defined in

src/ui/editors/select2editor.ts:175

---

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:100

---

addInplaceCreate

▸ Protected addInplaceCreate(addTitle, editTitle): void

Parameters

Name	Type
addTitle	string
editTitle	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:388

---

addItem

▸ addItem(item): void

Parameters

Name	Type
item	Select2Item

Returns

void

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

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

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

allowClear

▸ Protected allowClear(): boolean

Returns

boolean

Defined in

src/ui/editors/select2editor.ts:162

---

asyncSearch

▸ Protected asyncSearch(query, results): Select2SearchPromise

Parameters

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

Returns

Select2SearchPromise

Defined in

src/ui/editors/select2editor.ts:102

---

cascadeItems

▸ Protected cascadeItems(items): TItem[]

Parameters

Name	Type
items	TItem[]

Returns

TItem[]

Defined in

src/ui/editors/select2editor.ts:813

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

clearItems

▸ clearItems(): void

Returns

void

Defined in

src/ui/editors/select2editor.ts:363

---

createEditDialog

▸ Protected createEditDialog(callback): void

Parameters

Name	Type
callback	(dlg: IEditDialog) => void

Returns

void

Defined in

src/ui/editors/select2editor.ts:862

---

destroy

▸ destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/editors/select2editor.ts:91

---

editDialogDataChange

▸ Protected editDialogDataChange(): void

Returns

void

Defined in

src/ui/editors/select2editor.ts:895

---

emptyItemText

▸ Protected emptyItemText(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:114

---

filterItems

▸ Protected filterItems(items): TItem[]

Parameters

Name	Type
items	TItem[]

Returns

TItem[]

Defined in

src/ui/editors/select2editor.ts:835

---

getCascadeFromValue

▸ Protected getCascadeFromValue(parent): any

Parameters

Name	Type
parent	Widget<any>

Returns

any

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

Defined in

src/ui/editors/select2editor.ts:450

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getDialogTypeKey

▸ Protected getDialogTypeKey(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:854

---

getEditValue

▸ getEditValue(property, target): void

Parameters

Name	Type
property	PropertyItem
target	any

Returns

void

Implementation of

IGetEditValue.getEditValue

Defined in

src/ui/editors/select2editor.ts:508

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getIdField

▸ Protected getIdField(): any

Returns

any

Defined in

src/ui/editors/select2editor.ts:123

---

getPageSize

▸ Protected getPageSize(): number

Returns

number

Defined in

src/ui/editors/select2editor.ts:119

---

getSelect2Options

▸ Protected getSelect2Options(): Select2Options

Returns

Select2Options

Defined in

src/ui/editors/select2editor.ts:184

---

getTextField

▸ Protected getTextField(): any

Returns

any

Defined in

src/ui/editors/select2editor.ts:134

---

getTypeDelay

▸ Protected getTypeDelay(): any

Returns

any

Defined in

src/ui/editors/select2editor.ts:110

---

get_cascadeField

▸ Protected get_cascadeField(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:741

---

get_cascadeFrom

▸ Protected get_cascadeFrom(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:722

---

get_cascadeValue

▸ Protected get_cascadeValue(): any

Returns

any

Defined in

src/ui/editors/select2editor.ts:757

---

get_delimited

▸ get_delimited(): boolean

Returns

boolean

Defined in

src/ui/editors/select2editor.ts:328

---

get_filterField

▸ Protected get_filterField(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:777

---

get_filterValue

▸ Protected get_filterValue(): any

Returns

any

Defined in

src/ui/editors/select2editor.ts:793

---

get_itemByKey

▸ Protected get_itemByKey(): Object

Returns

Object

Defined in

src/ui/editors/select2editor.ts:525

---

get_items

▸ Protected get_items(): Select2Item[]

Returns

Select2Item[]

Defined in

src/ui/editors/select2editor.ts:521

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/editors/select2editor.ts:668

---

get_select2Container

▸ Protected get_select2Container(): JQuery

Returns

JQuery

Defined in

src/ui/editors/select2editor.ts:517

---

get_text

▸ Protected get_text(): string

Returns

string

Defined in

src/ui/editors/select2editor.ts:660

---

get_value

▸ get_value(): any

Returns

any

Implementation of

IStringValue.get_value

Defined in

src/ui/editors/select2editor.ts:551

---

get_values

▸ Protected get_values(): string[]

Returns

string[]

Defined in

src/ui/editors/select2editor.ts:623

---

hasAsyncSource

▸ Protected hasAsyncSource(): boolean

Returns

boolean

Defined in

src/ui/editors/select2editor.ts:98

---

init

▸ init(action?): Select2Editor<TOptions, TItem>

Parameters

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

Returns

Select2Editor<TOptions, TItem>

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:179

---

initNewEntity

▸ Protected initNewEntity(entity): void

Parameters

Name	Type
entity	TItem

Returns

void

Defined in

src/ui/editors/select2editor.ts:873

---

initialize

▸ initialize(): void

Returns

void

Inherited from

Widget.initialize

Defined in

src/ui/widgets/widget.ts:176

---

inplaceCreateClick

▸ Protected inplaceCreateClick(e): void

Parameters

Name	Type
e	JQueryEventObject

Returns

void

Defined in

src/ui/editors/select2editor.ts:901

---

isAutoComplete

▸ Protected isAutoComplete(): boolean

Returns

boolean

Defined in

src/ui/editors/select2editor.ts:446

---

isMultiple

▸ Protected isMultiple(): boolean

Returns

boolean

Defined in

src/ui/editors/select2editor.ts:167

---

itemDisabled

▸ Protected itemDisabled(item): boolean

Parameters

Name	Type
item	TItem

Returns

boolean

Defined in

src/ui/editors/select2editor.ts:145

---

itemId

▸ Protected itemId(item): string

Parameters

Name	Type
item	TItem

Returns

string

Defined in

src/ui/editors/select2editor.ts:127

---

itemText

▸ Protected itemText(item): string

Parameters

Name	Type
item	TItem

Returns

string

Defined in

src/ui/editors/select2editor.ts:138

---

mapItem

▸ Protected mapItem(item): Select2Item

Parameters

Name	Type
item	TItem

Returns

Select2Item

Defined in

src/ui/editors/select2editor.ts:149

---

mapItems

▸ Protected mapItems(items): Select2Item[]

Parameters

Name	Type
items	TItem[]

Returns

Select2Item[]

Defined in

src/ui/editors/select2editor.ts:158

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

setCascadeFrom

▸ Protected setCascadeFrom(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:703

---

setEditDialogReadOnly

▸ Protected setEditDialogReadOnly(dialog): void

Parameters

Name	Type
dialog	any

Returns

void

Defined in

src/ui/editors/select2editor.ts:887

---

setEditValue

▸ setEditValue(source, property): void

Parameters

Name	Type
source	any
property	PropertyItem

Returns

void

Implementation of

ISetEditValue.setEditValue

Defined in

src/ui/editors/select2editor.ts:498

---

setTermOnNewEntity

▸ Protected setTermOnNewEntity(entity, term): void

Parameters

Name	Type
entity	TItem
term	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:898

---

set_cascadeField

▸ Protected set_cascadeField(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:749

---

set_cascadeFrom

▸ Protected set_cascadeFrom(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:730

---

set_cascadeValue

▸ Protected set_cascadeValue(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/editors/select2editor.ts:765

---

set_filterField

▸ Protected set_filterField(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/select2editor.ts:785

---

set_filterValue

▸ Protected set_filterValue(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/editors/select2editor.ts:801

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/editors/select2editor.ts:686

---

set_value

▸ set_value(value): void

Parameters

Name	Type
value	string

Returns

void

Implementation of

IStringValue.set_value

Defined in

src/ui/editors/select2editor.ts:569

---

set_values

▸ Protected set_values(value): void

Parameters

Name	Type
value	string[]

Returns

void

Defined in

src/ui/editors/select2editor.ts:646

---

updateInplaceReadOnly

▸ Private updateInplaceReadOnly(): void

Returns

void

Defined in

src/ui/editors/select2editor.ts:676

---

updateItems

▸ Protected updateItems(): void

Returns

void

Defined in

src/ui/editors/select2editor.ts:851

---

useInplaceAdd

▸ Protected useInplaceAdd(): boolean

Returns

boolean

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

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

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

Defined in

src/ui/editors/select2editor.ts:529

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:124