@serenity-is/corelib / TemplatedDialog

Class: TemplatedDialog<P>

Type parameters

Name
P

Hierarchy

• TemplatedWidget<P>

  ↳ TemplatedDialog

  ↳↳ PropertyDialog

  ↳↳ FilterDialog

  ↳↳ ColumnPickerDialog

  ↳↳ EntityDialog

Table of contents

Constructors

• constructor

Properties

• dialog
• domNode
• idPrefix
• options
• tabs
• toolbar
• uniqueName
• validator
• typeInfo

Accessors

• dialogTitle
• element
• props

Methods

• addCssClass
• addValidationRule
• arrange
• byId
• change
• changeSelect2
• destroy
• dialogClose
• dialogOpen
• findById
• getCssClass
• getCustomAttribute
• getDialogButtons
• getDialogOptions
• getFieldElement
• getGridField
• getInitialDialogTitle
• getTemplate
• getToolbarButtons
• getValidatorOptions
• handleResponsive
• init
• initDialog
• initTabs
• initToolbar
• initUIDialog
• initValidator
• internalInit
• internalRenderContents
• isStaticPanel
• onDialogClose
• onDialogOpen
• render
• renderContents
• resetValidation
• syncOrAsyncThen
• useIdPrefix
• validateForm
• create
• createDefaultElement
• getWidgetName

Constructors

constructor

• new TemplatedDialog<P>(props?): TemplatedDialog<P>

Type parameters

Name
P

Parameters

Name	Type
props?	WidgetProps<P>

Returns

TemplatedDialog<P>

Overrides

TemplatedWidget.constructor

Defined in

src/ui/dialogs/templateddialog.ts:22

Properties

dialog

• Protected dialog: Dialog

Defined in

src/ui/dialogs/templateddialog.ts:20

---

domNode

• Readonly domNode: HTMLElement

Inherited from

TemplatedWidget.domNode

Defined in

src/ui/widgets/widget.ts:18

---

idPrefix

• Readonly idPrefix: string

Inherited from

TemplatedWidget.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

TemplatedWidget.options

Defined in

src/ui/widgets/widget.ts:15

---

tabs

• Protected tabs: Fluent<HTMLElement>

Defined in

src/ui/dialogs/templateddialog.ts:17

---

toolbar

• Protected toolbar: Toolbar<ToolbarOptions>

Defined in

src/ui/dialogs/templateddialog.ts:18

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

TemplatedWidget.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

validator

• Protected validator: any

Defined in

src/ui/dialogs/templateddialog.ts:19

---

typeInfo

▪ Static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

TemplatedWidget.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

dialogTitle

• get dialogTitle(): string

Returns

string

Defined in

src/ui/dialogs/templateddialog.ts:189

• set dialogTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:193

---

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

TemplatedWidget.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

TemplatedWidget.props

Defined in

src/ui/widgets/widget.ts:182

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Overrides

TemplatedWidget.addCssClass

Defined in

src/ui/dialogs/templateddialog.ts:46

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

Name	Type
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string
uniqueName?	string

Returns

void

Inherited from

TemplatedWidget.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

▸ addValidationRule(uniqueName, rule): void

Parameters

Name	Type
uniqueName	string
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string

Returns

void

Inherited from

TemplatedWidget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

arrange

▸ arrange(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:162

---

byId

▸ byId<TElement>(id): Fluent<TElement>

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

Fluent<TElement>

Inherited from

TemplatedWidget.byId

Defined in

src/ui/widgets/templatedwidget.ts:8

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

TemplatedWidget.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

TemplatedWidget.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

destroy

▸ destroy(): void

Returns

void

Overrides

TemplatedWidget.destroy

Defined in

src/ui/dialogs/templateddialog.ts:31

---

dialogClose

▸ dialogClose(result?): void

Parameters

Name	Type
result?	string

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:185

---

dialogOpen

▸ dialogOpen(asPanel?): void

Parameters

Name	Type
asPanel?	boolean

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:109

---

findById

▸ findById<TElement>(id): TElement

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

TElement

Inherited from

TemplatedWidget.findById

Defined in

src/ui/widgets/templatedwidget.ts:12

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

TemplatedWidget.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCustomAttribute

▸ getCustomAttribute<TAttr>(attrType, inherit?): TAttr

Type parameters

Name
TAttr

Parameters

Name	Type	Default value
attrType	(...args: any[]) => TAttr	undefined
inherit	boolean	true

Returns

TAttr

Inherited from

TemplatedWidget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getDialogButtons

▸ getDialogButtons(): DialogButton[]

Returns

DialogButton[]

Defined in

src/ui/dialogs/templateddialog.ts:181

---

getDialogOptions

▸ getDialogOptions(): DialogOptions

Returns

DialogOptions

Defined in

src/ui/dialogs/templateddialog.ts:58

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

TemplatedWidget.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

TemplatedWidget.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getInitialDialogTitle

▸ getInitialDialogTitle(): string

Returns

string

Defined in

src/ui/dialogs/templateddialog.ts:50

---

getTemplate

▸ getTemplate(): string

Returns

string

Inherited from

TemplatedWidget.getTemplate

Defined in

src/ui/widgets/templatedwidget.ts:16

---

getToolbarButtons

▸ getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Defined in

src/ui/dialogs/templateddialog.ts:127

---

getValidatorOptions

▸ getValidatorOptions(): any

Returns

any

Defined in

src/ui/dialogs/templateddialog.ts:142

---

handleResponsive

▸ handleResponsive(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:205

---

init

▸ init(): this

Returns

this

Inherited from

TemplatedWidget.init

Defined in

src/ui/widgets/widget.ts:146

---

initDialog

▸ initDialog(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:86

---

initTabs

▸ initTabs(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:198

---

initToolbar

▸ initToolbar(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:131

---

initUIDialog

▸ initUIDialog(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:95

---

initValidator

▸ initValidator(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:146

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

TemplatedWidget.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

TemplatedWidget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

isStaticPanel

▸ isStaticPanel(): boolean

Returns

boolean

Defined in

src/ui/dialogs/templateddialog.ts:54

---

onDialogClose

▸ onDialogClose(result?): void

Parameters

Name	Type
result?	string

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:168

---

onDialogOpen

▸ onDialogOpen(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:120

---

render

▸ render(): any

Returns the main element for this widget or the document fragment. As widgets may get their elements from props unlike regular JSX widgets, this method should not be overridden. Override renderContents() instead.

Returns

any

Inherited from

TemplatedWidget.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): void

Returns

void

Inherited from

TemplatedWidget.renderContents

Defined in

src/ui/widgets/templatedwidget.ts:20

---

resetValidation

▸ resetValidation(): void

Returns

void

Defined in

src/ui/dialogs/templateddialog.ts:154

---

syncOrAsyncThen

▸ syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void

Type parameters

Name
T

Parameters

Name	Type
syncMethod	() => T
asyncMethod	() => PromiseLike<T>
then	(v: T) => void

Returns

void

Inherited from

TemplatedWidget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

TemplatedWidget.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

validateForm

▸ validateForm(): boolean

Returns

boolean

Defined in

src/ui/dialogs/templateddialog.ts:158

---

create

▸ create<TWidget, P>(params): TWidget

Type parameters

Name	Type
TWidget	extends Widget<P>
P	P

Parameters

Name	Type
params	CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

TemplatedWidget.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLDivElement

Returns

HTMLDivElement

Overrides

TemplatedWidget.createDefaultElement

Defined in

src/ui/dialogs/templateddialog.ts:15

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

TemplatedWidget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95