@serenity-is/corelib / TemplatedWidget

Class: TemplatedWidget<TOptions>

Type parameters

Name
TOptions

Hierarchy

• Widget<TOptions>

  ↳ TemplatedWidget

  ↳↳ TemplatedDialog

  ↳↳ TemplatedPanel

  ↳↳ FilterWidgetBase

Table of contents

Constructors

• constructor

Properties

• element
• idPrefix
• options
• uniqueName
• widgetName
• templateNames

Methods

• addCssClass
• addValidationRule
• byID
• byId
• change
• changeSelect2
• destroy
• getCssClass
• getDefaultTemplateName
• getFallbackTemplate
• getGridField
• getTemplate
• getTemplateName
• init
• initialize
• renderContents
• useIdPrefix
• create
• elementFor
• getWidgetName
• noGeneric

Constructors

constructor

• new TemplatedWidget<TOptions>(element, options?)

Type parameters

Name
TOptions

Parameters

Name	Type
element	JQuery
options?	TOptions

Inherited from

Widget.constructor

Defined in

src/ui/widgets/widget.ts:67

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

---

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

---

templateNames

▪ Static Private templateNames: Object = {}

Index signature

▪ [key: string]: string

Defined in

src/ui/widgets/templatedwidget.ts:8

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:100

---

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

---

byID

▸ Private byID<TWidget>(id, type): TWidget

Type parameters

Name
TWidget

Parameters

Name	Type
id	string
type	(...args: any[]) => TWidget

Returns

TWidget

Defined in

src/ui/widgets/templatedwidget.ts:14

---

byId

▸ Protected byId(id): JQuery

Parameters

Name	Type
id	string

Returns

JQuery

Defined in

src/ui/widgets/templatedwidget.ts:10

---

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

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getDefaultTemplateName

▸ Private getDefaultTemplateName(): string

Returns

string

Defined in

src/ui/widgets/templatedwidget.ts:26

---

getFallbackTemplate

▸ Protected getFallbackTemplate(): string

Returns

string

Defined in

src/ui/widgets/templatedwidget.ts:79

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getTemplate

▸ Protected getTemplate(): string

Returns

string

Defined in

src/ui/widgets/templatedwidget.ts:83

---

getTemplateName

▸ Protected getTemplateName(): string

Returns

string

Defined in

src/ui/widgets/templatedwidget.ts:31

---

init

▸ init(action?): TemplatedWidget<TOptions>

Parameters

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

Returns

TemplatedWidget<TOptions>

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

---

renderContents

▸ Protected renderContents(): void

Returns

void

Overrides

Widget.renderContents

Defined in

src/ui/widgets/templatedwidget.ts:110

---

useIdPrefix

▸ Protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Defined in

src/ui/widgets/templatedwidget.ts:131

---

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

---

noGeneric

▸ Static Private noGeneric(s): string

Parameters

Name	Type
s	string

Returns

string

Defined in

src/ui/widgets/templatedwidget.ts:18