@serenity-is/corelib / BaseDialog

Class: BaseDialog<P>

Defined in: src/ui/dialogs/basedialog.tsx:12

Extends

Widget<P>

Extended by

Type Parameters

P

P

Constructors

Constructor

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

Defined in: src/ui/dialogs/basedialog.tsx:22

Parameters

props?

WidgetProps<P>

Returns

BaseDialog<P>

Overrides

Widget.constructor

Properties

dialog

protected dialog: Dialog

Defined in: src/ui/dialogs/basedialog.tsx:20

domNode

readonly domNode: HTMLElement

Defined in: src/ui/widgets/widget.ts:14

Inherited from

Widget.domNode

idPrefix

readonly idPrefix: string

Defined in: src/ui/widgets/widget.ts:13

Inherited from

Widget.idPrefix

options

protected readonly options: WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:11

Inherited from

Widget.options

tabs

protected tabs: Fluent<HTMLElement>

Defined in: src/ui/dialogs/basedialog.tsx:17

protected toolbar: Toolbar

Defined in: src/ui/dialogs/basedialog.tsx:18

uniqueName

readonly uniqueName: string

Defined in: src/ui/widgets/widget.ts:12

Inherited from

Widget.uniqueName

validator

protected validator: any

Defined in: src/ui/dialogs/basedialog.tsx:19

[typeInfo]

static [typeInfo]: ClassTypeInfo<"Serenity.">

Defined in: src/ui/dialogs/basedialog.tsx:13

Overrides

Widget.[typeInfo]

isComponent

readonly static isComponent: true = true

Defined in: src/ui/widgets/widget.ts:219

Inherited from

Widget.isComponent

Accessors

dialogTitle

Get Signature

get dialogTitle(): string

Defined in: src/ui/dialogs/basedialog.tsx:211

Returns

string

Set Signature

set dialogTitle(value): void

Defined in: src/ui/dialogs/basedialog.tsx:215

Parameters

value

string

Returns

void

element

Get Signature

get element(): Fluent

Defined in: src/ui/widgets/widget.ts:59

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

Widget.element

props

Get Signature

get props(): WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:203

Returns

WidgetProps<P>

Inherited from

Widget.props

Methods

addCssClass()

protected addCssClass(): void

Defined in: src/ui/dialogs/basedialog.tsx:58

Returns

void

Overrides

Widget.addCssClass

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Defined in: src/ui/widgets/widget.ts:95

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

Widget.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

Defined in: src/ui/widgets/widget.ts:96

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

Widget.addValidationRule

afterRender()

protected afterRender(callback): void

Defined in: src/ui/widgets/widget.ts:142

Parameters

callback

() => void

Returns

void

Inherited from

Widget.afterRender

arrange()

arrange(): void

Defined in: src/ui/dialogs/basedialog.tsx:184

Returns

void

byId()

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

Defined in: src/ui/widgets/widget.ts:102

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

Widget.byId

change()

change(handler): void

Defined in: src/ui/widgets/widget.ts:114

Parameters

handler

(e) => void

Returns

void

Inherited from

Widget.change

changeSelect2()

changeSelect2(handler): void

Defined in: src/ui/widgets/widget.ts:118

Parameters

handler

(e) => void

Returns

void

Inherited from

Widget.changeSelect2

deferRender()

protected deferRender(): boolean

Defined in: src/ui/widgets/widget.ts:67

Returns

boolean

Inherited from

Widget.deferRender

destroy()

destroy(): void

Defined in: src/ui/dialogs/basedialog.tsx:31

Returns

void

Overrides

Widget.destroy

dialogClose()

dialogClose(result?): void

Defined in: src/ui/dialogs/basedialog.tsx:207

Parameters

result?

string

Returns

void

dialogOpen()

dialogOpen(asPanel?): void

Defined in: src/ui/dialogs/basedialog.tsx:121

Parameters

asPanel?

boolean

Returns

void

findById()

protected findById<TElement>(id): TElement

Defined in: src/ui/widgets/widget.ts:106

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

Widget.findById

getCssClass()

protected getCssClass(): string

Defined in: src/ui/widgets/widget.ts:71

Returns

string

Inherited from

Widget.getCssClass

getCustomAttribute()

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

Defined in: src/ui/widgets/widget.ts:138

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

Widget.getCustomAttribute

getDialogButtons()

protected getDialogButtons(): DialogButton[]

Defined in: src/ui/dialogs/basedialog.tsx:203

Returns

DialogButton[]

getDialogOptions()

protected getDialogOptions(): DialogOptions

Defined in: src/ui/dialogs/basedialog.tsx:70

Returns

DialogOptions

getGridField()

getGridField(): Fluent

Defined in: src/ui/widgets/widget.ts:110

Returns

Fluent

Inherited from

Widget.getGridField

getInitialDialogTitle()

protected getInitialDialogTitle(): string

Defined in: src/ui/dialogs/basedialog.tsx:62

Returns

string

getToolbarButtons()

protected getToolbarButtons(): ToolButton[]

Defined in: src/ui/dialogs/basedialog.tsx:149

Returns

ToolButton[]

getValidatorOptions()

protected getValidatorOptions(): any

Defined in: src/ui/dialogs/basedialog.tsx:164

Returns

any

handleResponsive()

protected handleResponsive(): void

Defined in: src/ui/dialogs/basedialog.tsx:227

Returns

void

init()

init(): this

Defined in: src/ui/widgets/widget.ts:153

Returns

this

Inherited from

Widget.init

initDialog()

protected initDialog(): void

Defined in: src/ui/dialogs/basedialog.tsx:98

Returns

void

initTabs()

protected initTabs(): void

Defined in: src/ui/dialogs/basedialog.tsx:220

Returns

void

initToolbar()

protected initToolbar(): void

Defined in: src/ui/dialogs/basedialog.tsx:153

Returns

void

initUIDialog()

protected initUIDialog(): void

Defined in: src/ui/dialogs/basedialog.tsx:107

Returns

void

initValidator()

protected initValidator(): void

Defined in: src/ui/dialogs/basedialog.tsx:168

Returns

void

internalRenderContents()

internalRenderContents(): void

Defined in: src/ui/widgets/widget.ts:173

Returns

void

Inherited from

Widget.internalRenderContents

isStaticPanel()

protected isStaticPanel(): boolean

Defined in: src/ui/dialogs/basedialog.tsx:66

Returns

boolean

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Defined in: src/ui/widgets/widget.ts:190

Returns

boolean

Inherited from

Widget.legacyTemplateRender

onClose()

onClose(handler, opt?): void

Defined in: src/ui/dialogs/basedialog.tsx:140

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

Parameters

handler

(result?, e?) => void

opt?

before?

boolean

oneOff?

boolean

Returns

void

onDialogClose()

protected onDialogClose(result?): void

Defined in: src/ui/dialogs/basedialog.tsx:190

Parameters

result?

string

Returns

void

onDialogOpen()

protected onDialogOpen(): void

Defined in: src/ui/dialogs/basedialog.tsx:132

Returns

void

onOpen()

onOpen(handler, opt?): void

Defined in: src/ui/dialogs/basedialog.tsx:145

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

Parameters

handler

(e?) => void

opt?

before?

boolean

oneOff?

boolean

Returns

void

render()

render(): any

Defined in: src/ui/widgets/widget.ts:163

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

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/widget.ts:184

Returns

any

Inherited from

Widget.renderContents

resetValidation()

protected resetValidation(): void

Defined in: src/ui/dialogs/basedialog.tsx:176

Returns

void

syncOrAsyncThen()

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

Defined in: src/ui/widgets/widget.ts:207

Type Parameters

T

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

Widget.syncOrAsyncThen

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Defined in: src/ui/widgets/widget.ts:214

Returns

IdPrefixType

Inherited from

Widget.useIdPrefix

validateForm()

protected validateForm(): boolean

Defined in: src/ui/dialogs/basedialog.tsx:180

Returns

boolean

create()

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

Defined in: src/ui/widgets/widget.ts:126

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

Widget.create

createDefaultElement()

static createDefaultElement(): HTMLDivElement

Defined in: src/ui/dialogs/basedialog.tsx:15

Returns

HTMLDivElement

Overrides

Widget.createDefaultElement

getWidgetName()

static getWidgetName(type): string

Defined in: src/ui/widgets/widget.ts:91

Parameters

type

Function

Returns

string

Inherited from

Widget.getWidgetName

registerClass()

protected static registerClass<TypeName>(typeName, intfAndAttr?): ClassTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:221

Type Parameters

TypeName

TypeName

Parameters

registerEditor()

protected static registerEditor<TypeName>(typeName, intfAndAttr?): EditorTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:230

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

EditorTypeInfo<TypeName>

Inherited from

Widget.registerEditor