@serenity-is/corelib / EntityDialog

Class: EntityDialog<TItem, P>

Type parameters

Name	Type
TItem	TItem
P

Hierarchy

• TemplatedDialog<P>

  ↳ EntityDialog

Implements

• IEditDialog
• IReadOnly

Table of contents

Constructors

• constructor

Properties

• applyChangesButton
• cloneButton
• deleteButton
• dialog
• domNode
• editButton
• editClicked
• entity
• entityId
• idPrefix
• localizationButton
• localizationGrid
• localizationLastValue
• localizationPendingValue
• options
• propertyGrid
• propertyItemsData
• saveAndCloseButton
• tabs
• toolbar
• undeleteButton
• uniqueName
• validator
• defaultLanguageList
• typeInfo

Accessors

• dialogTitle
• element
• props
• readOnly

Methods

• addCssClass
• addValidationRule
• afterInit
• afterLoadEntity
• arrange
• beforeLoadEntity
• byId
• change
• changeSelect2
• deleteHandler
• destroy
• dialogClose
• dialogOpen
• doDelete
• findById
• getCloningEntity
• getCssClass
• getCustomAttribute
• getDeleteOptions
• getDeletePermission
• getDialogButtons
• getDialogOptions
• getEntityNameFieldValue
• getEntitySingular
• getEntityTitle
• getEntityType
• getFieldElement
• getFormKey
• getGridField
• getIdProperty
• getInitialDialogTitle
• getInsertPermission
• getIsActiveProperty
• getIsDeletedProperty
• getLanguages
• getLoadByIdOptions
• getLoadByIdRequest
• getLocalTextDbPrefix
• getLocalTextPrefix
• getLocalizationGridValue
• getNameProperty
• getPendingLocalizations
• getPropertyGridOptions
• getPropertyItems
• getPropertyItemsData
• getPropertyItemsDataAsync
• getRowDefinition
• getSaveEntity
• getSaveOptions
• getSaveRequest
• getService
• getTemplate
• getToolbarButtons
• getUndeleteOptions
• getUpdatePermission
• getValidatorOptions
• get_entity
• get_entityId
• get_readOnly
• handleResponsive
• hasDeletePermission
• hasInsertPermission
• hasSavePermission
• hasUpdatePermission
• init
• initDialog
• initLocalizationGrid
• initLocalizationGridCommon
• initPropertyGrid
• initTabs
• initToolbar
• initUIDialog
• initValidator
• internalInit
• internalRenderContents
• isCloneMode
• isDeleted
• isEditMode
• isLocalizationMode
• isLocalizationModeAndChanged
• isNew
• isNewOrDeleted
• isStaticPanel
• isViewMode
• load
• loadById
• loadByIdAndOpenDialog
• loadByIdHandler
• loadEntity
• loadEntityAndOpenDialog
• loadLocalization
• loadNewAndOpenDialog
• loadResponse
• localizationButtonClick
• onDeleteSuccess
• onDialogClose
• onDialogOpen
• onLoadingData
• onSaveSuccess
• propertyItemsReady
• reloadById
• render
• renderContents
• resetValidation
• save
• saveHandler
• save_submitHandler
• setLocalizationGridCurrentValues
• set_entity
• set_entityId
• set_readOnly
• showSaveSuccessMessage
• syncOrAsyncThen
• undelete
• undeleteHandler
• updateInterface
• updateTitle
• useAsync
• useIdPrefix
• useViewMode
• validateBeforeSave
• validateForm
• create
• createDefaultElement
• getWidgetName

Constructors

constructor

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

Type parameters

Name	Type
TItem	TItem
P

Parameters

Name	Type
props?	WidgetProps<P>

Returns

EntityDialog<TItem, P>

Overrides

TemplatedDialog.constructor

Defined in

src/ui/dialogs/entitydialog.ts:40

Properties

applyChangesButton

• Protected applyChangesButton: Fluent<HTMLElement>

Defined in

src/ui/dialogs/entitydialog.ts:27

---

cloneButton

• Protected cloneButton: Fluent<HTMLElement>

Defined in

src/ui/dialogs/entitydialog.ts:30

---

deleteButton

• Protected deleteButton: Fluent<HTMLElement>

Defined in

src/ui/dialogs/entitydialog.ts:28

---

dialog

• Protected dialog: Dialog

Inherited from

TemplatedDialog.dialog

Defined in

src/ui/dialogs/templateddialog.ts:20

---

domNode

• Readonly domNode: HTMLElement

Inherited from

TemplatedDialog.domNode

Defined in

src/ui/widgets/widget.ts:18

---

editButton

• Protected editButton: Fluent<HTMLElement>

Defined in

src/ui/dialogs/entitydialog.ts:31

---

editClicked

• Protected editClicked: boolean

Defined in

src/ui/dialogs/entitydialog.ts:1148

---

entity

• Protected entity: TItem

Defined in

src/ui/dialogs/entitydialog.ts:20

---

entityId

• Protected entityId: any

Defined in

src/ui/dialogs/entitydialog.ts:21

---

idPrefix

• Readonly idPrefix: string

Inherited from

TemplatedDialog.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

localizationButton

• Protected localizationButton: Fluent<HTMLElement>

Defined in

src/ui/dialogs/entitydialog.ts:34

---

localizationGrid

• Protected localizationGrid: PropertyGrid<PropertyGridOptions>

Defined in

src/ui/dialogs/entitydialog.ts:33

---

localizationLastValue

• Protected localizationLastValue: any

Defined in

src/ui/dialogs/entitydialog.ts:36

---

localizationPendingValue

• Protected localizationPendingValue: any

Defined in

src/ui/dialogs/entitydialog.ts:35

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

TemplatedDialog.options

Defined in

src/ui/widgets/widget.ts:15

---

propertyGrid

• Protected propertyGrid: PropertyGrid<PropertyGridOptions>

Defined in

src/ui/dialogs/entitydialog.ts:23

---

propertyItemsData

• Protected propertyItemsData: PropertyItemsData

Defined in

src/ui/dialogs/entitydialog.ts:22

---

saveAndCloseButton

• Protected saveAndCloseButton: Fluent<HTMLElement>

Defined in

src/ui/dialogs/entitydialog.ts:26

---

tabs

• Protected tabs: Fluent<HTMLElement>

Inherited from

TemplatedDialog.tabs

Defined in

src/ui/dialogs/templateddialog.ts:17

---

toolbar

• Protected toolbar: Toolbar<ToolbarOptions>

Overrides

TemplatedDialog.toolbar

Defined in

src/ui/dialogs/entitydialog.ts:25

---

undeleteButton

• Protected undeleteButton: Fluent<HTMLElement>

Defined in

src/ui/dialogs/entitydialog.ts:29

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

TemplatedDialog.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

validator

• Protected validator: any

Inherited from

TemplatedDialog.validator

Defined in

src/ui/dialogs/templateddialog.ts:19

---

defaultLanguageList

▪ Static defaultLanguageList: () => string[][]

Type declaration

▸ (): string[][]

Returns

string[][]

Defined in

src/ui/dialogs/entitydialog.ts:38

---

typeInfo

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

Inherited from

TemplatedDialog.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

dialogTitle

• get dialogTitle(): string

Returns

string

Inherited from

TemplatedDialog.dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:189

• set dialogTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

TemplatedDialog.dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:193

---

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

TemplatedDialog.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

TemplatedDialog.props

Defined in

src/ui/widgets/widget.ts:182

---

readOnly

• get readOnly(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:1097

• set readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:1101

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

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

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

TemplatedDialog.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterInit

▸ afterInit(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:55

---

afterLoadEntity

▸ afterLoadEntity(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:428

---

arrange

▸ arrange(): void

Returns

void

Inherited from

TemplatedDialog.arrange

Defined in

src/ui/dialogs/templateddialog.ts:162

---

beforeLoadEntity

▸ beforeLoadEntity(entity): void

Parameters

Name	Type
entity	TItem

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:423

---

byId

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

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

Fluent<TElement>

Inherited from

TemplatedDialog.byId

Defined in

src/ui/widgets/templatedwidget.ts:8

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

TemplatedDialog.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

TemplatedDialog.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

deleteHandler

▸ deleteHandler(options, callback): void

Parameters

Name	Type
options	ServiceOptions<DeleteResponse>
callback	(response: DeleteResponse) => void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:160

---

destroy

▸ destroy(): void

Returns

void

Overrides

TemplatedDialog.destroy

Defined in

src/ui/dialogs/entitydialog.ts:62

---

dialogClose

▸ dialogClose(result?): void

Parameters

Name	Type
result?	string

Returns

void

Inherited from

TemplatedDialog.dialogClose

Defined in

src/ui/dialogs/templateddialog.ts:185

---

dialogOpen

▸ dialogOpen(asPanel?): void

Parameters

Name	Type
asPanel?	boolean

Returns

void

Inherited from

TemplatedDialog.dialogOpen

Defined in

src/ui/dialogs/templateddialog.ts:109

---

doDelete

▸ doDelete(callback): void

Parameters

Name	Type
callback	(response: DeleteResponse) => void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:164

---

findById

▸ findById<TElement>(id): TElement

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

TElement

Inherited from

TemplatedDialog.findById

Defined in

src/ui/widgets/templatedwidget.ts:12

---

getCloningEntity

▸ getCloningEntity(): TItem

Returns

TItem

Defined in

src/ui/dialogs/entitydialog.ts:995

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

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

TemplatedDialog.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getDeleteOptions

▸ getDeleteOptions(callback): ServiceOptions<DeleteResponse>

Parameters

Name	Type
callback	(response: DeleteResponse) => void

Returns

ServiceOptions<DeleteResponse>

Defined in

src/ui/dialogs/entitydialog.ts:156

---

getDeletePermission

▸ getDeletePermission(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:1125

---

getDialogButtons

▸ getDialogButtons(): DialogButton[]

Returns

DialogButton[]

Inherited from

TemplatedDialog.getDialogButtons

Defined in

src/ui/dialogs/templateddialog.ts:181

---

getDialogOptions

▸ getDialogOptions(): DialogOptions

Returns

DialogOptions

Inherited from

TemplatedDialog.getDialogOptions

Defined in

src/ui/dialogs/templateddialog.ts:58

---

getEntityNameFieldValue

▸ getEntityNameFieldValue(): any

Returns

any

Defined in

src/ui/dialogs/entitydialog.ts:101

---

getEntitySingular

▸ getEntitySingular(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:267

---

getEntityTitle

▸ getEntityTitle(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:105

---

getEntityType

▸ getEntityType(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:202

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

TemplatedDialog.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getFormKey

▸ getFormKey(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:228

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

TemplatedDialog.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getIdProperty

▸ getIdProperty(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:296

---

getInitialDialogTitle

▸ getInitialDialogTitle(): string

Returns

string

Inherited from

TemplatedDialog.getInitialDialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:50

---

getInsertPermission

▸ getInsertPermission(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:1117

---

getIsActiveProperty

▸ getIsActiveProperty(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:313

---

getIsDeletedProperty

▸ getIsDeletedProperty(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:328

---

getLanguages

▸ getLanguages(): any[]

Returns

any[]

Defined in

src/ui/dialogs/entitydialog.ts:576

---

getLoadByIdOptions

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

Parameters

Name	Type
id	any
callback	(response: RetrieveResponse<TItem>) => void

Returns

ServiceOptions<RetrieveResponse<TItem>>

Defined in

src/ui/dialogs/entitydialog.ts:446

---

getLoadByIdRequest

▸ getLoadByIdRequest(id): RetrieveRequest

Parameters

Name	Type
id	any

Returns

RetrieveRequest

Defined in

src/ui/dialogs/entitydialog.ts:450

---

getLocalTextDbPrefix

▸ getLocalTextDbPrefix(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:241

---

getLocalTextPrefix

▸ getLocalTextPrefix(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:253

---

getLocalizationGridValue

▸ getLocalizationGridValue(): any

Returns

any

Defined in

src/ui/dialogs/entitydialog.ts:662

---

getNameProperty

▸ getNameProperty(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:278

---

getPendingLocalizations

▸ getPendingLocalizations(): any

Returns

any

Defined in

src/ui/dialogs/entitydialog.ts:675

---

getPropertyGridOptions

▸ getPropertyGridOptions(): PropertyGridOptions

Returns

PropertyGridOptions

Defined in

src/ui/dialogs/entitydialog.ts:746

---

getPropertyItems

▸ getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Defined in

src/ui/dialogs/entitydialog.ts:714

---

getPropertyItemsData

▸ getPropertyItemsData(): PropertyItemsData

Returns

PropertyItemsData

Defined in

src/ui/dialogs/entitydialog.ts:718

---

getPropertyItemsDataAsync

▸ getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Returns

Promise<PropertyItemsData>

Defined in

src/ui/dialogs/entitydialog.ts:737

---

getRowDefinition

▸ getRowDefinition(): IRowDefinition

Returns

IRowDefinition

Defined in

src/ui/dialogs/entitydialog.ts:196

---

getSaveEntity

▸ getSaveEntity(): TItem

Returns

TItem

Defined in

src/ui/dialogs/entitydialog.ts:795

---

getSaveOptions

▸ getSaveOptions(callback): ServiceOptions<SaveResponse>

Parameters

Name	Type
callback	(response: SaveResponse) => void

Returns

ServiceOptions<SaveResponse>

Defined in

src/ui/dialogs/entitydialog.ts:760

---

getSaveRequest

▸ getSaveRequest(): SaveRequest<TItem>

Returns

SaveRequest<TItem>

Defined in

src/ui/dialogs/entitydialog.ts:813

---

getService

▸ getService(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:334

---

getTemplate

▸ getTemplate(): string

Returns

string

Overrides

TemplatedDialog.getTemplate

Defined in

src/ui/dialogs/entitydialog.ts:1158

---

getToolbarButtons

▸ getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Overrides

TemplatedDialog.getToolbarButtons

Defined in

src/ui/dialogs/entitydialog.ts:872

---

getUndeleteOptions

▸ getUndeleteOptions(callback?): ServiceOptions<UndeleteResponse>

Parameters

Name	Type
callback?	(response: UndeleteResponse) => void

Returns

ServiceOptions<UndeleteResponse>

Defined in

src/ui/dialogs/entitydialog.ts:1065

---

getUpdatePermission

▸ getUpdatePermission(): string

Returns

string

Defined in

src/ui/dialogs/entitydialog.ts:1121

---

getValidatorOptions

▸ getValidatorOptions(): any

Returns

any

Inherited from

TemplatedDialog.getValidatorOptions

Defined in

src/ui/dialogs/templateddialog.ts:142

---

get_entity

▸ get_entity(): TItem

Returns

TItem

Defined in

src/ui/dialogs/entitydialog.ts:85

---

get_entityId

▸ get_entityId(): any

Returns

any

Defined in

src/ui/dialogs/entitydialog.ts:93

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/dialogs/entitydialog.ts:1105

---

handleResponsive

▸ handleResponsive(): void

Returns

void

Inherited from

TemplatedDialog.handleResponsive

Defined in

src/ui/dialogs/templateddialog.ts:205

---

hasDeletePermission

▸ hasDeletePermission(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:1129

---

hasInsertPermission

▸ hasInsertPermission(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:1134

---

hasSavePermission

▸ hasSavePermission(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:1144

---

hasUpdatePermission

▸ hasUpdatePermission(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:1139

---

init

▸ init(): this

Returns

this

Inherited from

TemplatedDialog.init

Defined in

src/ui/widgets/widget.ts:146

---

initDialog

▸ initDialog(): void

Returns

void

Inherited from

TemplatedDialog.initDialog

Defined in

src/ui/dialogs/templateddialog.ts:86

---

initLocalizationGrid

▸ initLocalizationGrid(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:486

---

initLocalizationGridCommon

▸ initLocalizationGridCommon(pgOptions): void

Parameters

Name	Type
pgOptions	PropertyGridOptions

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:495

---

initPropertyGrid

▸ initPropertyGrid(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:705

---

initTabs

▸ initTabs(): void

Returns

void

Inherited from

TemplatedDialog.initTabs

Defined in

src/ui/dialogs/templateddialog.ts:198

---

initToolbar

▸ initToolbar(): void

Returns

void

Overrides

TemplatedDialog.initToolbar

Defined in

src/ui/dialogs/entitydialog.ts:852

---

initUIDialog

▸ initUIDialog(): void

Returns

void

Inherited from

TemplatedDialog.initUIDialog

Defined in

src/ui/dialogs/templateddialog.ts:95

---

initValidator

▸ initValidator(): void

Returns

void

Inherited from

TemplatedDialog.initValidator

Defined in

src/ui/dialogs/templateddialog.ts:146

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

TemplatedDialog.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

TemplatedDialog.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

isCloneMode

▸ isCloneMode(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:122

---

isDeleted

▸ isDeleted(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:130

---

isEditMode

▸ isEditMode(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:126

---

isLocalizationMode

▸ isLocalizationMode(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:545

---

isLocalizationModeAndChanged

▸ isLocalizationModeAndChanged(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:549

---

isNew

▸ isNew(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:148

---

isNewOrDeleted

▸ isNewOrDeleted(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:152

---

isStaticPanel

▸ isStaticPanel(): boolean

Returns

boolean

Inherited from

TemplatedDialog.isStaticPanel

Defined in

src/ui/dialogs/templateddialog.ts:54

---

isViewMode

▸ isViewMode(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:1150

---

load

▸ load(entityOrId, done, fail?): void

Parameters

Name	Type
entityOrId	any
done	() => void
fail?	(ex: Exception) => void

Returns

void

Implementation of

IEditDialog.load

Defined in

src/ui/dialogs/entitydialog.ts:347

---

loadById

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

Parameters

Name	Type
id	any
callback?	(response: RetrieveResponse<TItem>) => void
fail?	() => void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:460

---

loadByIdAndOpenDialog

▸ loadByIdAndOpenDialog(entityId, asPanel?): void

Parameters

Name	Type
entityId	any
asPanel?	boolean

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:433

---

loadByIdHandler

▸ loadByIdHandler(options, callback, fail): void

Parameters

Name	Type
options	ServiceOptions<RetrieveResponse<TItem>>
callback	(response: RetrieveResponse<TItem>) => void
fail	() => void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:481

---

loadEntity

▸ loadEntity(entity): void

Parameters

Name	Type
entity	TItem

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:408

---

loadEntityAndOpenDialog

▸ loadEntityAndOpenDialog(entity, asPanel?): void

Parameters

Name	Type
entity	TItem
asPanel?	boolean

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:393

---

loadLocalization

▸ loadLocalization(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:598

---

loadNewAndOpenDialog

▸ loadNewAndOpenDialog(asPanel?): void

Parameters

Name	Type
asPanel?	boolean

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:388

---

loadResponse

▸ loadResponse(data): void

Parameters

Name	Type
data	any

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:398

---

localizationButtonClick

▸ localizationButtonClick(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:558

---

onDeleteSuccess

▸ onDeleteSuccess(response): void

Parameters

Name	Type
response	DeleteResponse

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:193

---

onDialogClose

▸ onDialogClose(result?): void

Parameters

Name	Type
result?	string

Returns

void

Inherited from

TemplatedDialog.onDialogClose

Defined in

src/ui/dialogs/templateddialog.ts:168

---

onDialogOpen

▸ onDialogOpen(): void

Returns

void

Inherited from

TemplatedDialog.onDialogOpen

Defined in

src/ui/dialogs/templateddialog.ts:120

---

onLoadingData

▸ onLoadingData(data): void

Parameters

Name	Type
data	RetrieveResponse<TItem>

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:443

---

onSaveSuccess

▸ onSaveSuccess(response): void

Parameters

Name	Type
response	SaveResponse

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:833

---

propertyItemsReady

▸ propertyItemsReady(itemsData): void

Parameters

Name	Type
itemsData	PropertyItemsData

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:49

---

reloadById

▸ reloadById(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:456

---

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

TemplatedDialog.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): void

Returns

void

Inherited from

TemplatedDialog.renderContents

Defined in

src/ui/widgets/templatedwidget.ts:20

---

resetValidation

▸ resetValidation(): void

Returns

void

Inherited from

TemplatedDialog.resetValidation

Defined in

src/ui/dialogs/templateddialog.ts:154

---

save

▸ save(callback?): boolean | void

Parameters

Name	Type
callback?	(response: SaveResponse) => void

Returns

boolean | void

Defined in

src/ui/dialogs/entitydialog.ts:841

---

saveHandler

▸ saveHandler(options, callback): void

Parameters

Name	Type
options	ServiceOptions<SaveResponse>
callback	(response: SaveResponse) => void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:847

---

save_submitHandler

▸ save_submitHandler(callback): void

Parameters

Name	Type
callback	(response: SaveResponse) => void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:836

---

setLocalizationGridCurrentValues

▸ setLocalizationGridCurrentValues(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:641

---

set_entity

▸ set_entity(entity): void

Parameters

Name	Type
entity	any

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:89

---

set_entityId

▸ set_entityId(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:97

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/dialogs/entitydialog.ts:1109

---

showSaveSuccessMessage

▸ showSaveSuccessMessage(response): void

Parameters

Name	Type
response	SaveResponse

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:868

---

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

TemplatedDialog.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

undelete

▸ undelete(callback?): void

Parameters

Name	Type
callback?	(response: UndeleteResponse) => void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:1073

---

undeleteHandler

▸ undeleteHandler(options, callback): void

Parameters

Name	Type
options	ServiceOptions<UndeleteResponse>
callback	(response: UndeleteResponse) => void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:1069

---

updateInterface

▸ updateInterface(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:1018

---

updateTitle

▸ updateTitle(): void

Returns

void

Defined in

src/ui/dialogs/entitydialog.ts:118

---

useAsync

▸ useAsync(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:58

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

TemplatedDialog.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

useViewMode

▸ useViewMode(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:1154

---

validateBeforeSave

▸ validateBeforeSave(): boolean

Returns

boolean

Defined in

src/ui/dialogs/entitydialog.ts:756

---

validateForm

▸ validateForm(): boolean

Returns

boolean

Inherited from

TemplatedDialog.validateForm

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

TemplatedDialog.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLDivElement

Returns

HTMLDivElement

Inherited from

TemplatedDialog.createDefaultElement

Defined in

src/ui/dialogs/templateddialog.ts:15

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

TemplatedDialog.getWidgetName

Defined in

src/ui/widgets/widget.ts:95