@serenity-is/corelib / BaseDialog

Class: BaseDialog<P>

Extends

• Widget<P>

Extended by

• PropertyDialog
• FilterDialog
• ColumnPickerDialog
• EntityDialog

Type Parameters

• P

Constructors

new BaseDialog()

new BaseDialog<P>(props?): BaseDialog<P>

Parameters

props?

WidgetProps<P>

Returns

BaseDialog<P>

Overrides

Widget.constructor

Defined in

src/ui/dialogs/basedialog.tsx:22

Properties

dialog

protected dialog: Dialog

Defined in

src/ui/dialogs/basedialog.tsx:20

---

domNode

readonly domNode: HTMLElement

Inherited from

Widget.domNode

Defined in

src/ui/widgets/widget.ts:17

---

idPrefix

readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:16

---

options

protected readonly options: WidgetProps<P>

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:14

---

tabs

protected tabs: Fluent<HTMLElement>

Defined in

src/ui/dialogs/basedialog.tsx:17

---

toolbar

protected toolbar: Toolbar<ToolbarOptions>

Defined in

src/ui/dialogs/basedialog.tsx:18

---

uniqueName

readonly uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:15

---

validator

protected validator: any

Defined in

src/ui/dialogs/basedialog.tsx:19

---

isComponent

readonly static isComponent: true = true

Inherited from

Widget.isComponent

Defined in

src/ui/widgets/widget.ts:223

---

typeInfo

static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

Widget.typeInfo

Defined in

src/ui/widgets/widget.ts:11

Accessors

dialogTitle

Get Signature

get dialogTitle(): string

Returns

string

Set Signature

set dialogTitle(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:210

---

element

Get Signature

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:63

---

props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

Widget.props

Defined in

src/ui/widgets/widget.ts:207

Methods

addCssClass()

protected addCssClass(): void

Returns

void

Overrides

Widget.addCssClass

Defined in

src/ui/dialogs/basedialog.tsx:57

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

Call Signature

addValidationRule(uniqueName, rule): void

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

Widget.afterRender

Defined in

src/ui/widgets/widget.ts:146

---

arrange()

arrange(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:183

---

byId()

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

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

Widget.byId

Defined in

src/ui/widgets/widget.ts:106

---

change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:118

---

changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:122

---

deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

Widget.deferRender

Defined in

src/ui/widgets/widget.ts:71

---

destroy()

destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/dialogs/basedialog.tsx:31

---

dialogClose()

dialogClose(result?): void

Parameters

result?

string

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:206

---

dialogOpen()

dialogOpen(asPanel?): void

Parameters

asPanel?

boolean

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:120

---

findById()

protected findById<TElement>(id): TElement

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

Widget.findById

Defined in

src/ui/widgets/widget.ts:110

---

getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCustomAttribute()

protected getCustomAttribute<TAttr>(attrType, inherit): TAttr

Type Parameters

• TAttr

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

Widget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142

---

getDialogButtons()

protected getDialogButtons(): DialogButton[]

Returns

DialogButton[]

Defined in

src/ui/dialogs/basedialog.tsx:202

---

getDialogOptions()

protected getDialogOptions(): DialogOptions

Returns

DialogOptions

Defined in

src/ui/dialogs/basedialog.tsx:69

---

getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:114

---

getInitialDialogTitle()

protected getInitialDialogTitle(): string

Returns

string

Defined in

src/ui/dialogs/basedialog.tsx:61

---

getToolbarButtons()

protected getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Defined in

src/ui/dialogs/basedialog.tsx:148

---

getValidatorOptions()

protected getValidatorOptions(): any

Returns

any

Defined in

src/ui/dialogs/basedialog.tsx:163

---

handleResponsive()

protected handleResponsive(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:226

---

init()

init(): this

Returns

this

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:157

---

initDialog()

protected initDialog(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:97

---

initTabs()

protected initTabs(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:219

---

initToolbar()

protected initToolbar(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:152

---

initUIDialog()

protected initUIDialog(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:106

---

initValidator()

protected initValidator(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:167

---

internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

Widget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177

---

isStaticPanel()

protected isStaticPanel(): boolean

Returns

boolean

Defined in

src/ui/dialogs/basedialog.tsx:65

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

Widget.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194

---

onClose()

onClose(handler, opt?): void

Attaches a dialog/modal/panel close event handler. See Dialog.close for more info.

Parameters

handler

(result?, e?) => void

opt?

opt.before

boolean

opt.oneOff

boolean

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:139

---

onDialogClose()

protected onDialogClose(result?): void

Parameters

result?

string

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:189

---

onDialogOpen()

protected onDialogOpen(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:131

---

onOpen()

onOpen(handler, opt?): void

Attaches a dialog/modal/panel open event handler. See Dialog.open for more info.

Parameters

handler

(e?) => void

opt?

opt.before

boolean

opt.oneOff

boolean

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:144

---

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

Widget.render

Defined in

src/ui/widgets/widget.ts:167

---

renderContents()

protected renderContents(): any

Returns

any

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:188

---

resetValidation()

protected resetValidation(): void

Returns

void

Defined in

src/ui/dialogs/basedialog.tsx:175

---

syncOrAsyncThen()

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

Type Parameters

• T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

Widget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

Widget.useIdPrefix

Defined in

src/ui/widgets/widget.ts:218

---

validateForm()

protected validateForm(): boolean

Returns

boolean

Defined in

src/ui/dialogs/basedialog.tsx:179

---

create()

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

Type Parameters

• TWidget extends Widget<P>

• P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

Widget.create

Defined in

src/ui/widgets/widget.ts:130

---

createDefaultElement()

static createDefaultElement(): HTMLDivElement

Returns

HTMLDivElement

Overrides

Widget.createDefaultElement

Defined in

src/ui/dialogs/basedialog.tsx:15

---

getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95