@serenity-is/corelib / Select2AjaxEditor

Class: Select2AjaxEditor<TOptions, TItem>

Type parameters

Name
TOptions
TItem

Hierarchy

• Widget<TOptions>

  ↳ Select2AjaxEditor

Implements

• IStringValue

Table of contents

Constructors

• constructor

Properties

• element
• idPrefix
• options
• pageSize
• uniqueName
• widgetName

Accessors

• value

Methods

• addCssClass
• addInplaceCreate
• addValidationRule
• change
• changeSelect2
• destroy
• emptyItemText
• executeQuery
• executeQueryByKey
• getCssClass
• getGridField
• getItemKey
• getItemText
• getSelect2Options
• getService
• getTypeDelay
• get_select2Container
• get_value
• init
• initialize
• inplaceCreateClick
• query
• queryByKey
• renderContents
• set_value
• create
• elementFor
• getWidgetName

Constructors

constructor

• new Select2AjaxEditor<TOptions, TItem>(hidden, opt)

Type parameters

Name
TOptions
TItem

Parameters

Name	Type
hidden	JQuery
opt	TOptions

Overrides

Widget.constructor

Defined in

src/ui/editors/select2ajaxeditor.ts:13

Properties

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

---

options

• Protected options: TOptions

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:62

---

pageSize

• pageSize: number = 50

Defined in

src/ui/editors/select2ajaxeditor.ts:11

---

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

value

• get value(): string

Returns

string

Defined in

src/ui/editors/select2ajaxeditor.ts:159

• set value(v): void

Parameters

Name	Type
v	string

Returns

void

Defined in

src/ui/editors/select2ajaxeditor.ts:177

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:100

---

addInplaceCreate

▸ Protected addInplaceCreate(title): void

Parameters

Name	Type
title	string

Returns

void

Defined in

src/ui/editors/select2ajaxeditor.ts:137

---

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

---

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

---

destroy

▸ destroy(): void

Returns

void

Inherited from

Widget.destroy

Defined in

src/ui/widgets/widget.ts:92

---

emptyItemText

▸ Protected emptyItemText(): string

Returns

string

Defined in

src/ui/editors/select2ajaxeditor.ts:32

---

executeQuery

▸ Protected executeQuery(options): void

Parameters

Name	Type
options	ServiceOptions<ListResponse<any>>

Returns

void

Defined in

src/ui/editors/select2ajaxeditor.ts:56

---

executeQueryByKey

▸ Protected executeQueryByKey(options): void

Parameters

Name	Type
options	ServiceOptions<RetrieveResponse<any>>

Returns

void

Defined in

src/ui/editors/select2ajaxeditor.ts:72

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getItemKey

▸ Protected getItemKey(item): string

Parameters

Name	Type
item	any

Returns

string

Defined in

src/ui/editors/select2ajaxeditor.ts:76

---

getItemText

▸ Protected getItemText(item): string

Parameters

Name	Type
item	any

Returns

string

Defined in

src/ui/editors/select2ajaxeditor.ts:80

---

getSelect2Options

▸ Protected getSelect2Options(): Select2Options

Returns

Select2Options

Defined in

src/ui/editors/select2ajaxeditor.ts:88

---

getService

▸ Protected getService(): string

Returns

string

Defined in

src/ui/editors/select2ajaxeditor.ts:40

---

getTypeDelay

▸ Protected getTypeDelay(): number

Returns

number

Defined in

src/ui/editors/select2ajaxeditor.ts:84

---

get_select2Container

▸ Protected get_select2Container(): JQuery

Returns

JQuery

Defined in

src/ui/editors/select2ajaxeditor.ts:151

---

get_value

▸ get_value(): string

Returns

string

Implementation of

IStringValue.get_value

Defined in

src/ui/editors/select2ajaxeditor.ts:155

---

init

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

Parameters

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

Returns

Select2AjaxEditor<TOptions, TItem>

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:179

---

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	any

Returns

void

Defined in

src/ui/editors/select2ajaxeditor.ts:148

---

query

▸ Protected query(request, callback): void

Parameters

Name	Type
request	ListRequest
callback	(p1: ListResponse<any>) => void

Returns

void

Defined in

src/ui/editors/select2ajaxeditor.ts:44

---

queryByKey

▸ Protected queryByKey(key, callback): void

Parameters

Name	Type
key	string
callback	(p1: any) => void

Returns

void

Defined in

src/ui/editors/select2ajaxeditor.ts:60

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

set_value

▸ set_value(value): void

Parameters

Name	Type
value	string

Returns

void

Implementation of

IStringValue.set_value

Defined in

src/ui/editors/select2ajaxeditor.ts:163

---

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

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:124