@serenity-is/corelib / EntityDialog

Class: EntityDialog<TItem, P>

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

Base dialog for editing entities, integrating property grids, save/delete operations, localization, and toolbar buttons.

Extends

• BaseDialog<P>

Type Parameters

TItem

TItem

Entity row type.

P

P = { }

Widget props type.

Implements

• IEditDialog
• IReadOnly

Constructors

Constructor

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

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

Creates an entity dialog and loads property items.

Parameters

props?

WidgetProps<P>

Widget props forwarded to the base dialog.

Returns

EntityDialog<TItem, P>

Overrides

BaseDialog.constructor

Properties

applyChangesButton

protected applyChangesButton: Fluent

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

---

cloneButton

protected cloneButton: Fluent

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

---

deleteButton

protected deleteButton: Fluent

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

---

dialog

protected dialog: Dialog

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

Inherited from

BaseDialog.dialog

---

domNode

readonly domNode: HTMLElement

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

The DOM node this widget is bound to.

Inherited from

BaseDialog.domNode

---

editButton

protected editButton: Fluent

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

---

editClicked

protected editClicked: boolean

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

---

idPrefix

readonly idPrefix: string

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

The id prefix used for this widget's child element ids.

Inherited from

BaseDialog.idPrefix

---

localizer

protected localizer: EntityLocalizer

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

---

localizerButton

protected localizerButton: Fluent

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

---

options

protected readonly options: WidgetProps<P>

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

The widget's options/props.

Inherited from

BaseDialog.options

---

propertyGrid

protected propertyGrid: PropertyGrid

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

---

propertyItemsData

protected propertyItemsData: PropertyItemsData

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

---

saveAndCloseButton

protected saveAndCloseButton: Fluent

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

---

tabs

protected tabs: Fluent<HTMLElement>

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

Inherited from

BaseDialog.tabs

---

toolbar

protected toolbar: Toolbar

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

Inherited from

BaseDialog.toolbar

---

undeleteButton

protected undeleteButton: Fluent

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

---

uniqueName

readonly uniqueName: string

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

A unique name for this widget instance, used for event namespacing.

Inherited from

BaseDialog.uniqueName

---

validator

protected validator: any

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

Inherited from

BaseDialog.validator

---

[typeInfo]

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

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

Implementation of

IReadOnly.[typeInfo]

Overrides

BaseDialog.[typeInfo]

---

isComponent

readonly static isComponent: true = true

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

Inherited from

BaseDialog.isComponent

Accessors

dialogTitle

Get Signature

get dialogTitle(): string

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

Returns the current dialog title.

Returns

string

The dialog title.

Set Signature

set dialogTitle(value): void

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

Sets the dialog title.

Parameters

value

string

Returns

void

Inherited from

BaseDialog.dialogTitle

---

element

Get Signature

get element(): Fluent

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

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:97

Returns the current entity.

Returns

TItem

The entity.

Set Signature

set entity(value): void

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

Sets the current entity.

Parameters

value

TItem

Returns

void

---

entityId

Get Signature

get entityId(): any

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

Returns the current entity id.

Returns

any

The entity id.

Set Signature

set entityId(value): void

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

Sets the current entity id.

Parameters

value

any

Returns

void

---

props

Get Signature

get props(): WidgetProps<P>

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

Returns the widget's props/options.

Returns

WidgetProps<P>

Inherited from

BaseDialog.props

---

readOnly

Get Signature

get readOnly(): boolean

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

Whether the dialog is in read-only mode.

Returns

boolean

Set Signature

set readOnly(value): void

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

Sets whether the dialog is in read-only mode.

Parameters

value

boolean

Returns

void

---

defaultLanguageList

Get Signature

get static defaultLanguageList(): string[][]

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

Returns the default language list for localization.

Returns

string[][]

The default language list.

Set Signature

set static defaultLanguageList(value): void

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

Sets the default language list for localization.

Parameters

value

string[][]

Returns

void

Methods

addCssClass()

protected addCssClass(): void

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

Hook for subclasses to add CSS classes; the class goes to the dialog/modal/panel element.

Returns

void

Inherited from

BaseDialog.addCssClass

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

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

Adds a validation rule to the widget's DOM node.

Parameters

rule

(input) => string

The validation rule function, or a unique name when the two-argument overload is used.

uniqueName?

string

A unique name for the rule, or the rule function when the two-argument overload is used.

Returns

void

Inherited from

BaseDialog.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

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

Adds a validation rule to the widget's DOM node.

Parameters

uniqueName

string

A unique name for the rule, or the rule function when the two-argument overload is used.

rule

(input) => string

The validation rule function, or a unique name when the two-argument overload is used.

Returns

void

Inherited from

BaseDialog.addValidationRule

---

afterInit()

protected afterInit(): void

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

Hook invoked after the dialog is initialized.

Returns

void

---

afterLoadEntity()

protected afterLoadEntity(): void

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

Hook invoked after loading an entity; updates the interface and title.

Returns

void

---

afterRender()

protected afterRender(callback): void

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

Queues a callback to run after the widget's contents are rendered.

Parameters

callback

() => void

The callback to run after rendering.

Returns

void

Inherited from

BaseDialog.afterRender

---

arrange()

arrange(): void

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

Triggers layout on all elements that require it.

Returns

void

Inherited from

BaseDialog.arrange

---

beforeLoadEntity()

protected beforeLoadEntity(entity): void

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

Hook invoked before loading an entity; clears localization state.

Parameters

entity

TItem

The entity being loaded.

Returns

void

---

byId()

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

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

Finds a child element by its prefix-relative id.

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

The id relative to the widget's id prefix.

Returns

Fluent<TElement>

A Fluent wrapper for the matching element.

Inherited from

BaseDialog.byId

---

change()

change(handler): void

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

Registers a change handler on the widget's DOM node.

Parameters

handler

(e) => void

The change event handler.

Returns

void

Inherited from

BaseDialog.change

---

changeSelect2()

changeSelect2(handler): void

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

Registers a change handler that ignores changes originating from combobox setting values.

Parameters

handler

(e) => void

The change event handler.

Returns

void

Inherited from

BaseDialog.changeSelect2

---

commitEdits()

protected commitEdits(): Promise<boolean>

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

Commits pending edits in the property grid.

Returns

Promise<boolean>

True when the commit succeeds.

---

deferRender()

protected deferRender(): boolean

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

Determines whether rendering should be deferred until init is called.

Returns

boolean

True to defer rendering.

Inherited from

BaseDialog.deferRender

---

deleteHandler()

protected deleteHandler(options, callback): PromiseLike<DeleteResponse>

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

Executes the delete service call.

Parameters

options

ServiceOptions<DeleteResponse>

Service options.

callback

(response) => void

Callback invoked on success.

Returns

PromiseLike<DeleteResponse>

A promise resolving to the delete response.

---

destroy()

destroy(): void

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

Cleans up the property grid, localizer, and toolbar buttons.

Returns

void

Overrides

BaseDialog.destroy

---

dialogClose()

dialogClose(result?): void

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

Closes the dialog with the given result.

Parameters

result?

string

The close result.

Returns

void

Inherited from

BaseDialog.dialogClose

---

dialogOpen()

dialogOpen(asPanel?): void

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

Opens the dialog, optionally as a panel.

Parameters

asPanel?

boolean

When true, opens as a panel instead of a modal dialog.

Returns

void

Inherited from

BaseDialog.dialogOpen

---

doDelete()

protected doDelete(callback): PromiseLike<DeleteResponse>

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

Deletes the current entity.

Parameters

callback

(response) => void

Callback invoked on success.

Returns

PromiseLike<DeleteResponse>

A promise resolving to the delete response.

---

findById()

protected findById<TElement>(id): TElement

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

Finds a child element by its prefix-relative id.

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

The id relative to the widget's id prefix.

Returns

TElement

The matching element, or null if not found.

Inherited from

BaseDialog.findById

---

get_entityId()

protected get_entityId(): any

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

Returns

any

Deprecated

use entityId

---

get_readOnly()

get_readOnly(): boolean

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

Returns whether the dialog is in read-only mode.

Returns

boolean

True when read-only.

Implementation of

IReadOnly.get_readOnly

---

getCloningEntity()

protected getCloningEntity(): TItem

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

Returns a clone of the current entity with identity and state fields removed.

Returns

TItem

The cloning entity.

---

getCreateServiceMethod()

protected getCreateServiceMethod(): string

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

Returns the create service method name.

Returns

string

The service method.

---

getCssClass()

protected getCssClass(): string

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

Returns the CSS class(es) applied to the widget's DOM node.

Returns

string

The space-separated CSS class string.

Inherited from

BaseDialog.getCssClass

---

getCustomAttribute()

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

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

Returns a custom attribute applied to the widget's type.

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

The attribute type to look up.

inherit

boolean = true

Whether to search inherited types; defaults to true.

Returns

TAttr

The matching attribute, or null.

Inherited from

BaseDialog.getCustomAttribute

---

getDeleteOptions()

protected getDeleteOptions(callback): ServiceOptions<DeleteResponse>

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

Returns the options for the delete service call.

Parameters

callback

(response) => void

Callback invoked on success.

Returns

ServiceOptions<DeleteResponse>

Service options.

---

getDeletePermission()

protected getDeletePermission(): string

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

Returns the delete permission for the entity.

Returns

string

The delete permission, or undefined.

---

getDeleteRequest()

protected getDeleteRequest(): DeleteRequest

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

Returns the delete request for the current entity.

Returns

DeleteRequest

The delete request.

---

getDeleteServiceMethod()

protected getDeleteServiceMethod(): string

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

Returns the delete service method name.

Returns

string

The service method.

---

getDialogButtons()

protected getDialogButtons(): DialogButton[]

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

Returns the dialog buttons for this dialog.

Returns

DialogButton[]

Dialog button definitions.

Inherited from

BaseDialog.getDialogButtons

---

getDialogOptions()

protected getDialogOptions(): DialogOptions

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

Returns the options used to create the underlying dialog.

Returns

DialogOptions

Dialog options.

Inherited from

BaseDialog.getDialogOptions

---

getEntityNameFieldValue()

protected getEntityNameFieldValue(): any

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

Returns the value of the entity name field.

Returns

any

The name field value.

---

getEntitySingular()

protected getEntitySingular(): string

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

Returns the localized singular name for the entity.

Returns

string

The entity singular name.

---

getEntityTitle()

protected getEntityTitle(): string

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

Returns the title for the dialog based on the current mode.

Returns

string

The dialog title.

---

getEntityType()

protected getEntityType(): string

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

Returns the entity type name derived from the dialog class name.

Returns

string

The entity type.

---

getFormKey()

protected getFormKey(): string

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

Returns the form key used to load property items.

Returns

string

The form key.

---

getGridField()

getGridField(): Fluent

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

Returns the closest .field element containing the widget's DOM node.

Returns

Fluent

A Fluent wrapper for the grid field.

Inherited from

BaseDialog.getGridField

---

getIdProperty()

protected getIdProperty(): string

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

Returns the id property for the entity.

Returns

string

The id property name.

---

getInitialDialogTitle()

protected getInitialDialogTitle(): string

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

Returns the initial dialog title.

Returns

string

The initial title text.

Inherited from

BaseDialog.getInitialDialogTitle

---

getInsertPermission()

protected getInsertPermission(): string

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

Returns the insert permission for the entity.

Returns

string

The insert permission, or undefined.

---

getIsActiveProperty()

protected getIsActiveProperty(): string

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

Returns the is-active property for the entity.

Returns

string

The is-active property name.

---

getIsDeletedProperty()

protected getIsDeletedProperty(): string

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

Returns

string

---

getLanguages()

protected getLanguages(): LanguageList

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

Returns the list of languages for localization.

Returns

LanguageList

The language list.

---

getLoadByIdOptions()

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

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

Returns the options for the retrieve service call.

Parameters

id

any

The entity id to load.

callback

(response) => void

Callback invoked on success.

Returns

ServiceOptions<RetrieveResponse<TItem>>

Service options.

---

getLoadByIdRequest()

protected getLoadByIdRequest(id): RetrieveRequest

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

Returns the retrieve request for an entity id.

Parameters

id

any

The entity id.

Returns

RetrieveRequest

The retrieve request.

---

getLocalizerOptions()

protected getLocalizerOptions(): EntityLocalizerOptions

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

Returns the options for the entity localizer.

Returns

EntityLocalizerOptions

Localizer options.

---

getLocalTextDbPrefix()

protected getLocalTextDbPrefix(): string

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

Returns the local text database prefix for this dialog.

Returns

string

The local text db prefix.

---

getLocalTextPrefix()

protected getLocalTextPrefix(): string

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

Returns the local text prefix for this dialog.

Returns

string

The local text prefix.

---

getNameProperty()

protected getNameProperty(): string

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

Returns the name property for the entity.

Returns

string

The name property name.

---

getPropertyGridOptions()

protected getPropertyGridOptions(): PropertyGridOptions

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

Returns the options for the property grid.

Returns

PropertyGridOptions

Property grid options.

---

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

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

Returns the property items for this dialog.

Returns

PropertyItem[]

The property items.

---

getPropertyItemsData()

protected getPropertyItemsData(): PropertyItemsData

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

Loads the property items data, either from script data or local items.

Returns

PropertyItemsData

The property items data.

---

getPropertyItemsDataAsync()

protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

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

Asynchronously loads the property items data.

Returns

Promise<PropertyItemsData>

A promise resolving to the property items data.

---

getRetrieveServiceMethod()

protected getRetrieveServiceMethod(): string

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

Returns the retrieve service method name.

Returns

string

The service method.

---

getRowDefinition()

protected getRowDefinition(): IRowDefinition

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

Returns the row definition for this dialog.

Returns

IRowDefinition

The row definition, or null.

---

getSaveEntity()

protected getSaveEntity(): TItem

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

Returns the entity populated from the property grid.

Returns

TItem

The saved entity.

---

getSaveOptions()

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

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

Returns the options for the save service call.

Parameters

callback

(response) => void

Callback invoked on success.

initiator?

SaveInitiator

How the save was initiated.

Returns

ServiceOptions<SaveResponse>

Service options.

---

getSaveRequest()

protected getSaveRequest(): SaveRequest<TItem>

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

Returns the save request for the current entity.

Returns

SaveRequest<TItem>

The save request.

---

getService()

protected getService(): string

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

Returns

string

---

getToolbarButtons()

protected getToolbarButtons(): ToolButton[]

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

Returns the toolbar buttons for the entity dialog.

Returns

ToolButton[]

Tool button definitions.

Overrides

BaseDialog.getToolbarButtons

---

getUndeleteOptions()

protected getUndeleteOptions(callback?): ServiceOptions<UndeleteResponse>

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

Returns the options for the undelete service call.

Parameters

callback?

(response) => void

Optional callback invoked on success.

Returns

ServiceOptions<UndeleteResponse>

Service options.

---

getUndeleteRequest()

protected getUndeleteRequest(): UndeleteRequest

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

Returns the undelete request for the current entity.

Returns

UndeleteRequest

The undelete request.

---

getUndeleteServiceMethod()

protected getUndeleteServiceMethod(): string

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

Returns the undelete service method name.

Returns

string

The service method.

---

getUpdatePermission()

protected getUpdatePermission(): string

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

Returns the update permission for the entity.

Returns

string

The update permission, or undefined.

---

getUpdateServiceMethod()

protected getUpdateServiceMethod(): string

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

Returns the update service method name.

Returns

string

The service method.

---

getValidatorOptions()

protected getValidatorOptions(): any

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

Returns the validator options for the form.

Returns

any

Validator options.

Inherited from

BaseDialog.getValidatorOptions

---

handleResponsive()

protected handleResponsive(): void

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

Handles responsive layout for the dialog.

Returns

void

Inherited from

BaseDialog.handleResponsive

---

hasDeletePermission()

protected hasDeletePermission(): boolean

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

Whether the current user has delete permission.

Returns

boolean

True when permitted.

---

hasInsertPermission()

protected hasInsertPermission(): boolean

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

Whether the current user has insert permission.

Returns

boolean

True when permitted.

---

hasSavePermission()

protected hasSavePermission(): boolean

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

Whether the current user has save permission (insert or update).

Returns

boolean

True when permitted.

---

hasUpdatePermission()

protected hasUpdatePermission(): boolean

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

Whether the current user has update permission.

Returns

boolean

True when permitted.

---

init()

init(): this

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

Initializes the widget, rendering its contents if rendering was deferred.

Returns

this

This widget instance.

Inherited from

BaseDialog.init

---

initDialog()

protected initDialog(): void

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

Initializes the underlying dialog element.

Returns

void

Inherited from

BaseDialog.initDialog

---

initLocalizer()

protected initLocalizer(): void

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

Initializes the entity localizer.

Returns

void

---

initPropertyGrid()

protected initPropertyGrid(): void

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

Initializes the property grid from the PropertyGrid element.

Returns

void

---

initTabs()

protected initTabs(): void

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

Initializes the tabs from the Tabs element.

Returns

void

Inherited from

BaseDialog.initTabs

---

initToolbar()

protected initToolbar(): void

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

Initializes the toolbar from the Toolbar element.

Returns

void

Inherited from

BaseDialog.initToolbar

---

initUIDialog()

protected initUIDialog(): void

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

Initializes jQuery UI dialog-specific behavior.

Returns

void

Inherited from

BaseDialog.initUIDialog

---

initValidator()

protected initValidator(): void

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

Initializes the form validator.

Returns

void

Inherited from

BaseDialog.initValidator

---

internalRenderContents()

internalRenderContents(): void

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

Renders the widget's contents and runs any queued after-render callbacks.

Returns

void

Inherited from

BaseDialog.internalRenderContents

---

isCloneMode()

protected isCloneMode(): boolean

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

Whether the dialog is in clone mode.

Returns

boolean

True when cloning.

---

isDeleted()

protected isDeleted(): boolean

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

Whether the current entity is soft-deleted.

Returns

boolean

True when deleted.

---

isEditMode()

protected isEditMode(): boolean

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

Whether the dialog is editing an existing entity.

Returns

boolean

True when editing.

---

isNew()

protected isNew(): boolean

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

Whether the dialog is creating a new entity.

Returns

boolean

True when new.

---

isNewOrDeleted()

protected isNewOrDeleted(): boolean

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

Whether the entity is new or soft-deleted.

Returns

boolean

True when new or deleted.

---

isStaticPanel()

protected isStaticPanel(): boolean

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

Whether the dialog renders as a static panel.

Returns

boolean

True when static.

Inherited from

BaseDialog.isStaticPanel

---

isViewMode()

protected isViewMode(): boolean

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

Whether the dialog is in view mode (read-only display of an existing entity).

Returns

boolean

True when in view mode.

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Renders the widget from a legacy getTemplate string, if defined.

Returns

boolean

True if a legacy template was rendered.

Inherited from

BaseDialog.legacyTemplateRender

---

load()

load(entityOrId, done, fail?): PromiseLike<RetrieveResponse<TItem>>

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

Loads an entity or id into the dialog.

Parameters

entityOrId

any

Entity instance or identifier to load.

done

() => void

Callback invoked when loading completes.

fail?

(ex) => void

Optional callback invoked on failure.

Returns

PromiseLike<RetrieveResponse<TItem>>

A promise resolving to the retrieve response.

Implementation of

IEditDialog.load

---

loadById()

loadById(id, callback?, fail?): PromiseLike<RetrieveResponse<TItem>>

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

Loads an entity by id.

Parameters

id

any

The entity id.

callback?

(response) => void

Optional callback invoked on success.

fail?

() => void

Optional callback invoked on failure.

Returns

PromiseLike<RetrieveResponse<TItem>>

A promise resolving to the retrieve response.

---

loadByIdAndOpenDialog()

loadByIdAndOpenDialog(entityId, asPanel?, callback?, fail?): PromiseLike<RetrieveResponse<TItem>>

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

Loads an entity by id and opens the dialog.

Parameters

entityId

any

The entity id to load.

asPanel?

boolean

When true, opens as a panel.

callback?

(response) => void

Optional callback invoked on success.

fail?

() => void

Optional callback invoked on failure.

Returns

PromiseLike<RetrieveResponse<TItem>>

A promise resolving to the retrieve response.

---

loadByIdHandler()

protected loadByIdHandler(options, callback, fail): PromiseLike<RetrieveResponse<TItem>>

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

Executes the retrieve service call.

Parameters

options

ServiceOptions<RetrieveResponse<TItem>>

Service options.

callback

(response) => void

Callback invoked on success.

fail

() => void

Callback invoked on failure.

Returns

PromiseLike<RetrieveResponse<TItem>>

A promise resolving to the retrieve response.

---

loadEntity()

protected loadEntity(entity): void

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

Loads an entity into the property grid.

Parameters

entity

TItem

The entity to load.

Returns

void

---

loadEntityAndOpenDialog()

loadEntityAndOpenDialog(entity, asPanel?): void

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

Loads an entity and opens the dialog.

Parameters

entity

TItem

The entity to load.

asPanel?

boolean

When true, opens as a panel.

Returns

void

---

loadNewAndOpenDialog()

loadNewAndOpenDialog(asPanel?): void

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

Loads a new empty entity and opens the dialog.

Parameters

asPanel?

boolean

When true, opens as a panel.

Returns

void

---

loadResponse()

protected loadResponse(data): void

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

Loads a retrieve response into the dialog.

Parameters

data

any

The retrieve response data.

Returns

void

---

onClose()

onClose(handler, opt?): void

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

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:267

Hook invoked after a successful delete.

Parameters

response

DeleteResponse

The delete response.

Returns

void

---

onDialogClose()

protected onDialogClose(result?): void

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

Hook invoked when the dialog closes; destroys the dialog and removes its element.

Parameters

result?

string

The close result.

Returns

void

Inherited from

BaseDialog.onDialogClose

---

onDialogOpen()

protected onDialogOpen(): void

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

Hook invoked when the dialog opens; focuses the first input and arranges layout.

Returns

void

Inherited from

BaseDialog.onDialogOpen

---

onLoadingData()

protected onLoadingData(data): void

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

Hook invoked when data starts loading.

Parameters

data

RetrieveResponse<TItem>

The retrieve response data.

Returns

void

---

onOpen()

onOpen(handler, opt?): void

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

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:834

Hook invoked after a successful save.

Parameters

response

SaveResponse

The save response.

initiator?

SaveInitiator

How the save was initiated.

Returns

void

---

propertyItemsReady()

protected propertyItemsReady(itemsData): void

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

Called once property items are available; initializes the property grid and localizer.

Parameters

itemsData

PropertyItemsData

Property items data.

Returns

void

---

reloadById()

protected reloadById(): void

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

Reloads the current entity by id.

Returns

void

---

render()

render(): any

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

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:1160

Renders the dialog contents with toolbar, form, and property grid.

Returns

any

The rendered content.

Overrides

BaseDialog.renderContents

---

resetValidation()

protected resetValidation(): void

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

Resets all validation state.

Returns

void

Inherited from

BaseDialog.resetValidation

---

retrieveLocalizations()

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

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

Retrieves existing localizations for the current entity.

Returns

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

A promise resolving to the localizations keyed by language.

---

save()

protected save(callback?, initiator?): false | PromiseLike<SaveResponse>

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

Validates and saves the entity.

Parameters

callback?

(response) => void

Optional callback invoked on success.

initiator?

SaveInitiator

How the save was initiated.

Returns

false | PromiseLike<SaveResponse>

A promise resolving to the save response, or false when validation fails.

---

save_submitHandler()

protected save_submitHandler(callback, initiator): PromiseLike<SaveResponse>

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

Submits the save after validation.

Parameters

callback

(response) => void

Callback invoked on success.

initiator

SaveInitiator

How the save was initiated.

Returns

PromiseLike<SaveResponse>

A promise resolving to the save response.

---

saveHandler()

protected saveHandler(options, callback, initiator): PromiseLike<SaveResponse>

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

Executes the save service call.

Parameters

options

ServiceOptions<SaveResponse>

Service options.

callback

(response) => void

Callback invoked on success.

initiator

SaveInitiator

How the save was initiated.

Returns

PromiseLike<SaveResponse>

A promise resolving to the save response.

---

set_readOnly()

set_readOnly(value): void

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

Sets whether the dialog is in read-only mode and updates the interface.

Parameters

value

boolean

True to enable read-only mode.

Returns

void

Implementation of

IReadOnly.set_readOnly

---

showSaveSuccessMessage()

protected showSaveSuccessMessage(response, initiator?): void

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

Shows a success message after saving.

Parameters

response

SaveResponse

The save response.

initiator?

SaveInitiator

How the save was initiated.

Returns

void

---

syncOrAsyncThen()

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

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

Runs a method synchronously or asynchronously depending on the widget's useAsync flag, then invokes a continuation.

Type Parameters

T

T

Parameters

syncMethod

() => T

The synchronous method to run.

asyncMethod

() => PromiseLike<T>

The asynchronous method to run.

then

(v) => void

The continuation invoked with the result.

Returns

void

Inherited from

BaseDialog.syncOrAsyncThen

---

undelete()

protected undelete(callback?): void | PromiseLike<UndeleteResponse>

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

Undeletes the current entity.

Parameters

callback?

(response) => void

Optional callback invoked on success.

Returns

void | PromiseLike<UndeleteResponse>

Void or a promise resolving to the undelete response.

---

undeleteHandler()

protected undeleteHandler(options, callback?): PromiseLike<UndeleteResponse>

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

Executes the undelete service call.

Parameters

options

ServiceOptions<UndeleteResponse>

Service options.

callback?

(response) => void

Optional callback invoked on success.

Returns

PromiseLike<UndeleteResponse>

A promise resolving to the undelete response.

---

updateInterface()

protected updateInterface(): void

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

Updates the interface to reflect the current mode and permissions.

Returns

void

---

updateTitle()

protected updateTitle(): void

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

Updates the dialog title from the entity.

Returns

void

---

useAsync()

protected useAsync(): boolean

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

Whether property items should be loaded asynchronously.

Returns

boolean

True when async loading is used.

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns an id prefix helper for resolving child element ids.

Returns

IdPrefixType

An IdPrefixType proxy for this widget's id prefix.

Inherited from

BaseDialog.useIdPrefix

---

useViewMode()

protected useViewMode(): boolean

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

Whether view mode is enabled for this dialog.

Returns

boolean

True when view mode is used.

---

validateBeforeSave()

protected validateBeforeSave(): boolean

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

Validates the form before saving.

Returns

boolean

True when the form is valid.

---

validateForm()

protected validateForm(): boolean

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

Validates the form.

Returns

boolean

True when the form is valid.

Inherited from

BaseDialog.validateForm

---

create()

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

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

Creates a widget instance from the given params, appending its element to the container and invoking the init/init callbacks.

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

The widget creation params.

Returns

TWidget

The created widget instance.

Inherited from

BaseDialog.create

---

createDefaultElement()

static createDefaultElement(): HTMLDivElement

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

Creates the default DOM element for a widget.

Returns

HTMLDivElement

A new div element.

Inherited from

BaseDialog.createDefaultElement

---

getWidgetName()

static getWidgetName(type): string

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

Returns the widget name for a type, used for association and unique names.

Parameters

type

Function

The widget type.

Returns

string

The widget name.

Inherited from

BaseDialog.getWidgetName

---

registerClass()

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

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

Registers this type as a class with the given type name.

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

The type name to register.

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Optional interfaces and attributes.

Returns

ClassTypeInfo<TypeName>

The class type info.

Inherited from

BaseDialog.registerClass

---

registerEditor()

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

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

Registers this type as an editor with the given type name.

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

The type name to register.

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Optional interfaces and attributes.

Returns

EditorTypeInfo<TypeName>

The editor type info.

Inherited from

BaseDialog.registerEditor