@serenity-is/corelib / EntityDialog

Class: EntityDialog<TItem, P>

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

Extends

BaseDialog<P>

Type Parameters

TItem

TItem

P

P = { }

Implements

Constructors

Constructor

new EntityDialog<TItem, P>(props?): EntityDialog<TItem, P>

Defined in: src/ui/dialogs/entitydialog.tsx:37

Parameters

props?

WidgetProps<P>

Returns

EntityDialog<TItem, P>

Overrides

BaseDialog.constructor

Properties

applyChangesButton

protected applyChangesButton: Fluent

Defined in: src/ui/dialogs/entitydialog.tsx:28

cloneButton

protected cloneButton: Fluent

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

deleteButton

protected deleteButton: Fluent

Defined in: src/ui/dialogs/entitydialog.tsx:29

dialog

protected dialog: Dialog

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

Inherited from

BaseDialog.dialog

domNode

readonly domNode: HTMLElement

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

Inherited from

BaseDialog.domNode

editButton

protected editButton: Fluent

Defined in: src/ui/dialogs/entitydialog.tsx:32

editClicked

protected editClicked: boolean

Defined in: src/ui/dialogs/entitydialog.tsx:745

idPrefix

readonly idPrefix: string

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

Inherited from

BaseDialog.idPrefix

localizer

protected localizer: EntityLocalizer

Defined in: src/ui/dialogs/entitydialog.tsx:34

localizerButton

protected localizerButton: Fluent

Defined in: src/ui/dialogs/entitydialog.tsx:35

options

protected readonly options: WidgetProps<P>

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

Inherited from

BaseDialog.options

propertyGrid

protected propertyGrid: PropertyGrid

Defined in: src/ui/dialogs/entitydialog.tsx:25

propertyItemsData

protected propertyItemsData: PropertyItemsData

Defined in: src/ui/dialogs/entitydialog.tsx:24

saveAndCloseButton

protected saveAndCloseButton: Fluent

Defined in: src/ui/dialogs/entitydialog.tsx:27

tabs

protected tabs: Fluent<HTMLElement>

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

Inherited from

BaseDialog.tabs

protected toolbar: Toolbar

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

Inherited from

BaseDialog.toolbar

undeleteButton

protected undeleteButton: Fluent

Defined in: src/ui/dialogs/entitydialog.tsx:30

uniqueName

readonly uniqueName: string

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

Inherited from

BaseDialog.uniqueName

validator

protected validator: any

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

Inherited from

BaseDialog.validator

[typeInfo]

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

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

Implementation of

IReadOnly.[typeInfo]

Overrides

BaseDialog.[typeInfo]

isComponent

readonly static isComponent: true = true

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

Inherited from

BaseDialog.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

Inherited from

BaseDialog.dialogTitle

element

Get Signature

get element(): Fluent

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

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

BaseDialog.element

entity

Get Signature

get entity(): TItem

Defined in: src/ui/dialogs/entitydialog.tsx:69

Returns

TItem

Set Signature

set entity(value): void

Defined in: src/ui/dialogs/entitydialog.tsx:73

Parameters

value

TItem

Returns

void

entityId

Get Signature

get entityId(): any

Defined in: src/ui/dialogs/entitydialog.tsx:82

Returns

any

Set Signature

set entityId(value): void

Defined in: src/ui/dialogs/entitydialog.tsx:86

Parameters

value

any

Returns

void

props

Get Signature

get props(): WidgetProps<P>

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

Returns

WidgetProps<P>

Inherited from

BaseDialog.props

readOnly

Get Signature

get readOnly(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:694

Returns

boolean

Set Signature

set readOnly(value): void

Defined in: src/ui/dialogs/entitydialog.tsx:698

Parameters

value

boolean

Returns

void

defaultLanguageList

Get Signature

get static defaultLanguageList(): string[][]

Defined in: src/ui/dialogs/entitydialog.tsx:770

Returns

string[][]

Set Signature

set static defaultLanguageList(value): void

Defined in: src/ui/dialogs/entitydialog.tsx:774

Parameters

value

string[][]

Returns

void

Methods

addCssClass()

protected addCssClass(): void

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

Returns

void

Inherited from

BaseDialog.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

BaseDialog.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

BaseDialog.addValidationRule

afterInit()

protected afterInit(): void

Defined in: src/ui/dialogs/entitydialog.tsx:52

Returns

void

afterLoadEntity()

protected afterLoadEntity(): void

Defined in: src/ui/dialogs/entitydialog.tsx:358

Returns

void

afterRender()

protected afterRender(callback): void

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

Parameters

callback

() => void

Returns

void

Inherited from

BaseDialog.afterRender

arrange()

arrange(): void

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

Returns

void

Inherited from

BaseDialog.arrange

beforeLoadEntity()

protected beforeLoadEntity(entity): void

Defined in: src/ui/dialogs/entitydialog.tsx:354

Parameters

entity

TItem

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

BaseDialog.byId

change()

change(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

BaseDialog.change

changeSelect2()

changeSelect2(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

BaseDialog.changeSelect2

deferRender()

protected deferRender(): boolean

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

Returns

boolean

Inherited from

BaseDialog.deferRender

deleteHandler()

protected deleteHandler(options, callback): void

Defined in: src/ui/dialogs/entitydialog.tsx:142

Parameters

options

ServiceOptions<DeleteResponse>

callback

(response) => void

Returns

void

destroy()

destroy(): void

Defined in: src/ui/dialogs/entitydialog.tsx:59

Returns

void

Overrides

BaseDialog.destroy

dialogClose()

dialogClose(result?): void

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

Parameters

result?

string

Returns

void

Inherited from

BaseDialog.dialogClose

dialogOpen()

dialogOpen(asPanel?): void

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

Parameters

asPanel?

boolean

Returns

void

Inherited from

BaseDialog.dialogOpen

doDelete()

protected doDelete(callback): void

Defined in: src/ui/dialogs/entitydialog.tsx:150

Parameters

callback

(response) => void

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

BaseDialog.findById

get_entityId()

protected get_entityId(): any

Defined in: src/ui/dialogs/entitydialog.tsx:78

Returns

any

Deprecated

use entityId

get_readOnly()

get_readOnly(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:702

Returns

boolean

Implementation of

IReadOnly.get_readOnly

getCloningEntity()

protected getCloningEntity(): TItem

Defined in: src/ui/dialogs/entitydialog.tsx:634

Returns

TItem

getCreateServiceMethod()

protected getCreateServiceMethod(): string

Defined in: src/ui/dialogs/entitydialog.tsx:501

Returns

string

getCssClass()

protected getCssClass(): string

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

Returns

string

Inherited from

BaseDialog.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

BaseDialog.getCustomAttribute

getDeleteOptions()

protected getDeleteOptions(callback): ServiceOptions<DeleteResponse>

Defined in: src/ui/dialogs/entitydialog.tsx:138

Parameters

callback

(response) => void

Returns

ServiceOptions<DeleteResponse>

getDeletePermission()

protected getDeletePermission(): string

Defined in: src/ui/dialogs/entitydialog.tsx:722

Returns

string

getDeleteServiceMethod()

protected getDeleteServiceMethod(): string

Defined in: src/ui/dialogs/entitydialog.tsx:146

Returns

string

getDialogButtons()

protected getDialogButtons(): DialogButton[]

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

Returns

DialogButton[]

Inherited from

BaseDialog.getDialogButtons

getDialogOptions()

protected getDialogOptions(): DialogOptions

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

Returns

DialogOptions

Inherited from

BaseDialog.getDialogOptions

getEntityNameFieldValue()

protected getEntityNameFieldValue(): any

Defined in: src/ui/dialogs/entitydialog.tsx:90

Returns

any

getEntitySingular()

protected getEntitySingular(): string

Defined in: src/ui/dialogs/entitydialog.tsx:232

Returns

string

getEntityTitle()

protected getEntityTitle(): string

Defined in: src/ui/dialogs/entitydialog.tsx:94

Returns

string

getEntityType()

protected getEntityType(): string

Defined in: src/ui/dialogs/entitydialog.tsx:181

Returns

string

getFormKey()

protected getFormKey(): string

Defined in: src/ui/dialogs/entitydialog.tsx:202

Returns

string

getGridField()

getGridField(): Fluent

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

Returns

Fluent

Inherited from

BaseDialog.getGridField

getIdProperty()

protected getIdProperty(): string

Defined in: src/ui/dialogs/entitydialog.tsx:254

Returns

string

getInitialDialogTitle()

protected getInitialDialogTitle(): string

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

Returns

string

Inherited from

BaseDialog.getInitialDialogTitle

getInsertPermission()

protected getInsertPermission(): string

Defined in: src/ui/dialogs/entitydialog.tsx:714

Returns

string

getIsActiveProperty()

protected getIsActiveProperty(): string

Defined in: src/ui/dialogs/entitydialog.tsx:267

Returns

string

getIsDeletedProperty()

protected getIsDeletedProperty(): string

Defined in: src/ui/dialogs/entitydialog.tsx:275

Returns

string

getLanguages()

protected getLanguages(): LanguageList

Defined in: src/ui/dialogs/entitydialog.tsx:452

Returns

LanguageList

getLoadByIdOptions()

protected getLoadByIdOptions(id, callback): ServiceOptions<RetrieveResponse<TItem>>

Defined in: src/ui/dialogs/entitydialog.tsx:380

Parameters

id

any

callback

(response) => void

Returns

ServiceOptions<RetrieveResponse<TItem>>

getLoadByIdRequest()

protected getLoadByIdRequest(id): RetrieveRequest

Defined in: src/ui/dialogs/entitydialog.tsx:393

Parameters

id

any

Returns

RetrieveRequest

getLocalizerOptions()

protected getLocalizerOptions(): EntityLocalizerOptions

Defined in: src/ui/dialogs/entitydialog.tsx:431

Returns

EntityLocalizerOptions

getLocalTextDbPrefix()

protected getLocalTextDbPrefix(): string

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

Returns

string

getLocalTextPrefix()

protected getLocalTextPrefix(): string

Defined in: src/ui/dialogs/entitydialog.tsx:223

Returns

string

getNameProperty()

protected getNameProperty(): string

Defined in: src/ui/dialogs/entitydialog.tsx:241

Returns

string

getPropertyGridOptions()

protected getPropertyGridOptions(): PropertyGridOptions

Defined in: src/ui/dialogs/entitydialog.tsx:488

Returns

PropertyGridOptions

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

Defined in: src/ui/dialogs/entitydialog.tsx:464

Returns

PropertyItem[]

getPropertyItemsData()

protected getPropertyItemsData(): PropertyItemsData

Defined in: src/ui/dialogs/entitydialog.tsx:468

Returns

PropertyItemsData

getPropertyItemsDataAsync()

protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Defined in: src/ui/dialogs/entitydialog.tsx:483

Returns

Promise<PropertyItemsData>

getRetrieveServiceMethod()

protected getRetrieveServiceMethod(): string

Defined in: src/ui/dialogs/entitydialog.tsx:403

Returns

string

getRowDefinition()

protected getRowDefinition(): IRowDefinition

Defined in: src/ui/dialogs/entitydialog.tsx:175

Returns

IRowDefinition

getSaveEntity()

protected getSaveEntity(): TItem

Defined in: src/ui/dialogs/entitydialog.tsx:526

Returns

TItem

getSaveOptions()

protected getSaveOptions(callback, initiator?): ServiceOptions<SaveResponse>

Defined in: src/ui/dialogs/entitydialog.tsx:509

Parameters

callback

(response) => void

initiator?

SaveInitiator

Returns

ServiceOptions<SaveResponse>

getSaveRequest()

protected getSaveRequest(): SaveRequest<TItem>

Defined in: src/ui/dialogs/entitydialog.tsx:539

Returns

SaveRequest<TItem>

getService()

protected getService(): string

Defined in: src/ui/dialogs/entitydialog.tsx:281

Returns

string

getToolbarButtons()

protected getToolbarButtons(): ToolButton[]

Defined in: src/ui/dialogs/entitydialog.tsx:573

Returns

ToolButton[]

Overrides

BaseDialog.getToolbarButtons

getUndeleteOptions()

protected getUndeleteOptions(callback?): ServiceOptions<UndeleteResponse>

Defined in: src/ui/dialogs/entitydialog.tsx:662

Parameters

callback?

(response) => void

Returns

ServiceOptions<UndeleteResponse>

getUndeleteServiceMethod()

protected getUndeleteServiceMethod(): string

Defined in: src/ui/dialogs/entitydialog.tsx:670

Returns

string

getUpdatePermission()

protected getUpdatePermission(): string

Defined in: src/ui/dialogs/entitydialog.tsx:718

Returns

string

getUpdateServiceMethod()

protected getUpdateServiceMethod(): string

Defined in: src/ui/dialogs/entitydialog.tsx:505

Returns

string

getValidatorOptions()

protected getValidatorOptions(): any

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

Returns

any

Inherited from

BaseDialog.getValidatorOptions

handleResponsive()

protected handleResponsive(): void

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

Returns

void

Inherited from

BaseDialog.handleResponsive

hasDeletePermission()

protected hasDeletePermission(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:726

Returns

boolean

hasInsertPermission()

protected hasInsertPermission(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:731

Returns

boolean

hasSavePermission()

protected hasSavePermission(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:741

Returns

boolean

hasUpdatePermission()

protected hasUpdatePermission(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:736

Returns

boolean

init()

init(): this

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

Returns

this

Inherited from

BaseDialog.init

initDialog()

protected initDialog(): void

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

Returns

void

Inherited from

BaseDialog.initDialog

initLocalizer()

protected initLocalizer(): void

Defined in: src/ui/dialogs/entitydialog.tsx:447

Returns

void

initPropertyGrid()

protected initPropertyGrid(): void

Defined in: src/ui/dialogs/entitydialog.tsx:456

Returns

void

initTabs()

protected initTabs(): void

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

Returns

void

Inherited from

BaseDialog.initTabs

initToolbar()

protected initToolbar(): void

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

Returns

void

Inherited from

BaseDialog.initToolbar

initUIDialog()

protected initUIDialog(): void

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

Returns

void

Inherited from

BaseDialog.initUIDialog

initValidator()

protected initValidator(): void

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

Returns

void

Inherited from

BaseDialog.initValidator

internalRenderContents()

internalRenderContents(): void

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

Returns

void

Inherited from

BaseDialog.internalRenderContents

isCloneMode()

protected isCloneMode(): boolean

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

Returns

boolean

isDeleted()

protected isDeleted(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:115

Returns

boolean

isEditMode()

protected isEditMode(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:111

Returns

boolean

isNew()

protected isNew(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:130

Returns

boolean

isNewOrDeleted()

protected isNewOrDeleted(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:134

Returns

boolean

isStaticPanel()

protected isStaticPanel(): boolean

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

Returns

boolean

Inherited from

BaseDialog.isStaticPanel

isViewMode()

protected isViewMode(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:747

Returns

boolean

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Returns

boolean

Inherited from

BaseDialog.legacyTemplateRender

load()

load(entityOrId, done, fail?): void

Defined in: src/ui/dialogs/entitydialog.tsx:288

Parameters

entityOrId

any

done

() => void

fail?

(ex) => void

Returns

void

Implementation of

IEditDialog.load

loadById()

loadById(id, callback?, fail?): void

Defined in: src/ui/dialogs/entitydialog.tsx:407

Parameters

id

any

callback?

(response) => void

fail?

() => void

Returns

void

loadByIdAndOpenDialog()

loadByIdAndOpenDialog(entityId, asPanel?, callback?, fail?): void

Defined in: src/ui/dialogs/entitydialog.tsx:363

Parameters

entityId

any

asPanel?

boolean

callback?

(response) => void

fail?

() => void

Returns

void

loadByIdHandler()

protected loadByIdHandler(options, callback, fail): void

Defined in: src/ui/dialogs/entitydialog.tsx:411

Parameters

options

ServiceOptions<RetrieveResponse<TItem>>

callback

(response) => void

fail

() => void

Returns

void

loadEntity()

protected loadEntity(entity): void

Defined in: src/ui/dialogs/entitydialog.tsx:344

Parameters

entity

TItem

Returns

void

loadEntityAndOpenDialog()

loadEntityAndOpenDialog(entity, asPanel?): void

Defined in: src/ui/dialogs/entitydialog.tsx:328

Parameters

entity

TItem

asPanel?

boolean

Returns

void

loadNewAndOpenDialog()

loadNewAndOpenDialog(asPanel?): void

Defined in: src/ui/dialogs/entitydialog.tsx:323

Parameters

asPanel?

boolean

Returns

void

loadResponse()

protected loadResponse(data): void

Defined in: src/ui/dialogs/entitydialog.tsx:333

Parameters

data

any

Returns

void

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

Inherited from

BaseDialog.onClose

onDeleteSuccess()

protected onDeleteSuccess(response): void

Defined in: src/ui/dialogs/entitydialog.tsx:172

Parameters

response

DeleteResponse

Returns

void

onDialogClose()

protected onDialogClose(result?): void

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

Parameters

result?

string

Returns

void

Inherited from

BaseDialog.onDialogClose

onDialogOpen()

protected onDialogOpen(): void

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

Returns

void

Inherited from

BaseDialog.onDialogOpen

onLoadingData()

protected onLoadingData(data): void

Defined in: src/ui/dialogs/entitydialog.tsx:377

Parameters

data

RetrieveResponse<TItem>

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

Inherited from

BaseDialog.onOpen

onSaveSuccess()

protected onSaveSuccess(response, initiator?): void

Defined in: src/ui/dialogs/entitydialog.tsx:550

Parameters

response

SaveResponse

initiator?

SaveInitiator

Returns

void

propertyItemsReady()

protected propertyItemsReady(itemsData): void

Defined in: src/ui/dialogs/entitydialog.tsx:46

Parameters

itemsData

PropertyItemsData

Returns

void

reloadById()

protected reloadById(): void

Defined in: src/ui/dialogs/entitydialog.tsx:399

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

BaseDialog.render

renderContents()

protected renderContents(): any

Defined in: src/ui/dialogs/entitydialog.tsx:755

Returns

any

Overrides

BaseDialog.renderContents

resetValidation()

protected resetValidation(): void

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

Returns

void

Inherited from

BaseDialog.resetValidation

retrieveLocalizations()

protected retrieveLocalizations(): Promise<Record<string, Partial<TItem>>>

Defined in: src/ui/dialogs/entitydialog.tsx:416

Returns

Promise<Record<string, Partial<TItem>>>

save()

protected save(callback?, initiator?): boolean | void

Defined in: src/ui/dialogs/entitydialog.tsx:559

Parameters

callback?

(response) => void

initiator?

SaveInitiator

Returns

boolean | void

save_submitHandler()

protected save_submitHandler(callback, initiator): void

Defined in: src/ui/dialogs/entitydialog.tsx:554

Parameters

callback

(response) => void

initiator

SaveInitiator

Returns

void

saveHandler()

protected saveHandler(options, callback, initiator): void

Defined in: src/ui/dialogs/entitydialog.tsx:565

Parameters

options

ServiceOptions<SaveResponse>

callback

(response) => void

initiator

SaveInitiator

Returns

void

set_readOnly()

set_readOnly(value): void

Defined in: src/ui/dialogs/entitydialog.tsx:706

Parameters

value

boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

showSaveSuccessMessage()

protected showSaveSuccessMessage(response, initiator?): void

Defined in: src/ui/dialogs/entitydialog.tsx:569

Parameters

response

SaveResponse

initiator?

SaveInitiator

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

BaseDialog.syncOrAsyncThen

undelete()

protected undelete(callback?): void

Defined in: src/ui/dialogs/entitydialog.tsx:674

Parameters

callback?

(response) => void

Returns

void

undeleteHandler()

protected undeleteHandler(options, callback): void

Defined in: src/ui/dialogs/entitydialog.tsx:666

Parameters

options

ServiceOptions<UndeleteResponse>

callback

(response) => void

Returns

void

updateInterface()

protected updateInterface(): void

Defined in: src/ui/dialogs/entitydialog.tsx:653

Returns

void

updateTitle()

protected updateTitle(): void

Defined in: src/ui/dialogs/entitydialog.tsx:103

Returns

void

useAsync()

protected useAsync(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:55

Returns

boolean

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns

IdPrefixType

Inherited from

BaseDialog.useIdPrefix

useViewMode()

protected useViewMode(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:751

Returns

boolean

validateBeforeSave()

protected validateBeforeSave(): boolean

Defined in: src/ui/dialogs/entitydialog.tsx:497

Returns

boolean

validateForm()

protected validateForm(): boolean

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

Returns

boolean

Inherited from

BaseDialog.validateForm

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

BaseDialog.create

createDefaultElement()

static createDefaultElement(): HTMLDivElement

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

Returns

HTMLDivElement

Inherited from

BaseDialog.createDefaultElement

getWidgetName()

static getWidgetName(type): string

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

Parameters

type

Function

Returns

string

Inherited from

BaseDialog.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

BaseDialog.registerEditor