@serenity-is/corelib / Widget

Class: Widget<TOptions>

Type parameters

Name	Type
TOptions	any

Hierarchy

• Widget

  ↳ PopupMenuButton

  ↳ Toolbar

  ↳ TemplatedWidget

  ↳ PropertyGrid

  ↳ StringEditor

  ↳ TextAreaEditor

  ↳ BooleanEditor

  ↳ DecimalEditor

  ↳ IntegerEditor

  ↳ DateEditor

  ↳ DateTimeEditor

  ↳ TimeEditor

  ↳ EmailEditor

  ↳ RadioButtonEditor

  ↳ Select2Editor

  ↳ HtmlContentEditor

  ↳ MaskedEditor

  ↳ Recaptcha

  ↳ FileUploadEditor

  ↳ MultipleFileUploadEditor

  ↳ QuickFilterBar

  ↳ QuickSearchInput

  ↳ SlickPager

  ↳ DataGrid

  ↳ ReportPage

  ↳ Flexify

  ↳ GoogleMap

  ↳ Select2AjaxEditor

Table of contents

Constructors

• constructor

Properties

• element
• idPrefix
• options
• uniqueName
• widgetName
• __isWidgetType
• nextWidgetNumber

Methods

• addCssClass
• addValidationRule
• change
• changeSelect2
• destroy
• getCssClass
• getGridField
• init
• initialize
• renderContents
• create
• elementFor
• getWidgetName

Constructors

constructor

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

Type parameters

Name	Type
TOptions	any

Parameters

Name	Type
element	JQuery
options?	TOptions

Defined in

src/ui/widgets/widget.ts:67

Properties

element

• element: JQuery

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Defined in

src/ui/widgets/widget.ts:65

---

options

• Protected options: TOptions

Defined in

src/ui/widgets/widget.ts:62

---

uniqueName

• Protected uniqueName: string

Defined in

src/ui/widgets/widget.ts:64

---

widgetName

• Protected widgetName: string

Defined in

src/ui/widgets/widget.ts:63

---

__isWidgetType

▪ Static Private __isWidgetType: boolean = true

Defined in

src/ui/widgets/widget.ts:187

---

nextWidgetNumber

▪ Static Private nextWidgetNumber: number = 0

Defined in

src/ui/widgets/widget.ts:60

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Defined in

src/ui/widgets/widget.ts:100

---

addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

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

Returns

JQuery

Defined in

src/ui/widgets/widget.ts:134

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Defined in

src/ui/widgets/widget.ts:260

---

destroy

▸ destroy(): void

Returns

void

Defined in

src/ui/widgets/widget.ts:92

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Defined in

src/ui/widgets/widget.ts:104

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Defined in

src/ui/widgets/widget.ts:138

---

init

▸ init(action?): Widget<TOptions>

Parameters

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

Returns

Widget<TOptions>

Defined in

src/ui/widgets/widget.ts:179

---

initialize

▸ initialize(): void

Returns

void

Defined in

src/ui/widgets/widget.ts:176

---

renderContents

▸ Protected renderContents(): void

Returns

void

Defined in

src/ui/widgets/widget.ts:184

---

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

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

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Defined in

src/ui/widgets/widget.ts:124