@serenity-is/corelib / EntityDialog
Class: EntityDialog<TItem, P>
Extends
BaseDialog<P>
Type Parameters
• TItem
• P = {}
Implements
Constructors
new EntityDialog()
new EntityDialog<
TItem,P>(props?):EntityDialog<TItem,P>
Parameters
props?
WidgetProps<P>
Returns
EntityDialog<TItem, P>
Overrides
Defined in
src/ui/dialogs/entitydialog.tsx:38
Properties
applyChangesButton
protectedapplyChangesButton:Fluent<HTMLElement>
Defined in
src/ui/dialogs/entitydialog.tsx:29
cloneButton
protectedcloneButton:Fluent<HTMLElement>
Defined in
src/ui/dialogs/entitydialog.tsx:32
deleteButton
protecteddeleteButton:Fluent<HTMLElement>
Defined in
src/ui/dialogs/entitydialog.tsx:30
dialog
protecteddialog:Dialog
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:20
domNode
readonlydomNode:HTMLElement
Inherited from
Defined in
editButton
protectededitButton:Fluent<HTMLElement>
Defined in
src/ui/dialogs/entitydialog.tsx:33
editClicked
protectededitClicked:boolean
Defined in
src/ui/dialogs/entitydialog.tsx:758
idPrefix
readonlyidPrefix:string
Inherited from
Defined in
localizer
protectedlocalizer:EntityLocalizer
Defined in
src/ui/dialogs/entitydialog.tsx:35
localizerButton
protectedlocalizerButton:Fluent<HTMLElement>
Defined in
src/ui/dialogs/entitydialog.tsx:36
options
protectedreadonlyoptions:WidgetProps<P>
Inherited from
Defined in
propertyGrid
protectedpropertyGrid:PropertyGrid<PropertyGridOptions>
Defined in
src/ui/dialogs/entitydialog.tsx:26
propertyItemsData
protectedpropertyItemsData:PropertyItemsData
Defined in
src/ui/dialogs/entitydialog.tsx:25
saveAndCloseButton
protectedsaveAndCloseButton:Fluent<HTMLElement>
Defined in
src/ui/dialogs/entitydialog.tsx:28
tabs
protectedtabs:Fluent<HTMLElement>
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:17
toolbar
protectedtoolbar:Toolbar<ToolbarOptions>
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:18
undeleteButton
protectedundeleteButton:Fluent<HTMLElement>
Defined in
src/ui/dialogs/entitydialog.tsx:31
uniqueName
readonlyuniqueName:string
Inherited from
Defined in
validator
protectedvalidator:any
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:19
isComponent
readonlystaticisComponent:true=true
Inherited from
Defined in
typeInfo
statictypeInfo:ClassTypeInfo<"Serenity.Widget">
Inherited from
Defined in
Accessors
dialogTitle
Get Signature
get dialogTitle():
string
Returns
string
Set Signature
set dialogTitle(
value):void
Parameters
value
string
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:210
element
Get Signature
get element():
Fluent<HTMLElement>
Returns a Fluent(this.domNode) object
Returns
Fluent<HTMLElement>
Inherited from
Defined in
entity
Get Signature
get entity():
TItem
Returns
TItem
Set Signature
set entity(
value):void
Parameters
value
TItem
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:70
entityId
Get Signature
get entityId():
any
Returns
any
Set Signature
set entityId(
value):void
Parameters
value
any
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:83
props
Get Signature
get props():
WidgetProps<P>
Returns
WidgetProps<P>
Inherited from
Defined in
readOnly
Get Signature
get readOnly():
boolean
Returns
boolean
Set Signature
set readOnly(
value):void
Parameters
value
boolean
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:707
defaultLanguageList
Get Signature
get
staticdefaultLanguageList():string[][]
Returns
string[][]
Set Signature
set
staticdefaultLanguageList(value):void
Parameters
value
string[][]
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:783
Methods
addCssClass()
protectedaddCssClass():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:57
addValidationRule()
Call Signature
addValidationRule(
rule,uniqueName?):void
Parameters
rule
(input) => string
uniqueName?
string
Returns
void
Inherited from
Defined in
Call Signature
addValidationRule(
uniqueName,rule):void
Parameters
uniqueName
string
rule
(input) => string
Returns
void
Inherited from
Defined in
afterInit()
protectedafterInit():void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:53
afterLoadEntity()
protectedafterLoadEntity():void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:371
afterRender()
protectedafterRender(callback):void
Parameters
callback
() => void
Returns
void
Inherited from
Defined in
arrange()
arrange():
void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:183
beforeLoadEntity()
protectedbeforeLoadEntity(entity):void
Parameters
entity
TItem
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:367
byId()
protectedbyId<TElement>(id):Fluent<TElement>
Type Parameters
• TElement extends HTMLElement = HTMLElement
Parameters
id
string
Returns
Fluent<TElement>
Inherited from
Defined in
change()
change(
handler):void
Parameters
handler
(e) => void
Returns
void
Inherited from
Defined in
changeSelect2()
changeSelect2(
handler):void
Parameters
handler
(e) => void
Returns
void
Inherited from
Defined in
deferRender()
protecteddeferRender():boolean
Returns
boolean
Inherited from
Defined in
deleteHandler()
protecteddeleteHandler(options,callback):void
Parameters
options
ServiceOptions<DeleteResponse>
callback
(response) => void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:143
destroy()
destroy():
void
Returns
void
Overrides
Defined in
src/ui/dialogs/entitydialog.tsx:60
dialogClose()
dialogClose(
result?):void
Parameters
result?
string
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:206
dialogOpen()
dialogOpen(
asPanel?):void
Parameters
asPanel?
boolean
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:120
doDelete()
protecteddoDelete(callback):void
Parameters
callback
(response) => void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:151
findById()
protectedfindById<TElement>(id):TElement
Type Parameters
• TElement extends HTMLElement = HTMLElement
Parameters
id
string
Returns
TElement
Inherited from
Defined in
get_entityId()
protectedget_entityId():any
Returns
any
Deprecated
use entityId
Defined in
src/ui/dialogs/entitydialog.tsx:79
get_readOnly()
get_readOnly():
boolean
Returns
boolean
Implementation of
Defined in
src/ui/dialogs/entitydialog.tsx:715
getCloningEntity()
protectedgetCloningEntity():TItem
Returns
TItem
Defined in
src/ui/dialogs/entitydialog.tsx:647
getCreateServiceMethod()
protectedgetCreateServiceMethod():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:514
getCssClass()
protectedgetCssClass():string
Returns
string
Inherited from
Defined in
getCustomAttribute()
protectedgetCustomAttribute<TAttr>(attrType,inherit):TAttr
Type Parameters
• TAttr
Parameters
attrType
(...args) => TAttr
inherit
boolean = true
Returns
TAttr
Inherited from
Defined in
getDeleteOptions()
protectedgetDeleteOptions(callback):ServiceOptions<DeleteResponse>
Parameters
callback
(response) => void
Returns
ServiceOptions<DeleteResponse>
Defined in
src/ui/dialogs/entitydialog.tsx:139
getDeletePermission()
protectedgetDeletePermission():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:735
getDeleteServiceMethod()
protectedgetDeleteServiceMethod():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:147
getDialogButtons()
protectedgetDialogButtons():DialogButton[]
Returns
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:202
getDialogOptions()
protectedgetDialogOptions():DialogOptions
Returns
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:69
getEntityNameFieldValue()
protectedgetEntityNameFieldValue():any
Returns
any
Defined in
src/ui/dialogs/entitydialog.tsx:91
getEntitySingular()
protectedgetEntitySingular():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:239
getEntityTitle()
protectedgetEntityTitle():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:95
getEntityType()
protectedgetEntityType():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:182
getFormKey()
protectedgetFormKey():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:207
getGridField()
getGridField():
Fluent<HTMLElement>
Returns
Fluent<HTMLElement>
Inherited from
Defined in
getIdProperty()
protectedgetIdProperty():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:264
getInitialDialogTitle()
protectedgetInitialDialogTitle():string
Returns
string
Inherited from
BaseDialog.getInitialDialogTitle
Defined in
src/ui/dialogs/basedialog.tsx:61
getInsertPermission()
protectedgetInsertPermission():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:727
getIsActiveProperty()
protectedgetIsActiveProperty():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:278
getIsDeletedProperty()
protectedgetIsDeletedProperty():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:286
getLanguages()
protectedgetLanguages():LanguageList
Returns
Defined in
src/ui/dialogs/entitydialog.tsx:465
getLoadByIdOptions()
protectedgetLoadByIdOptions(id,callback):ServiceOptions<RetrieveResponse<TItem>>
Parameters
id
any
callback
(response) => void
Returns
ServiceOptions<RetrieveResponse<TItem>>
Defined in
src/ui/dialogs/entitydialog.tsx:393
getLoadByIdRequest()
protectedgetLoadByIdRequest(id):RetrieveRequest
Parameters
id
any
Returns
Defined in
src/ui/dialogs/entitydialog.tsx:406
getLocalizerOptions()
protectedgetLocalizerOptions():EntityLocalizerOptions
Returns
Defined in
src/ui/dialogs/entitydialog.tsx:444
getLocalTextDbPrefix()
protectedgetLocalTextDbPrefix():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:217
getLocalTextPrefix()
protectedgetLocalTextPrefix():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:229
getNameProperty()
protectedgetNameProperty():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:250
getPropertyGridOptions()
protectedgetPropertyGridOptions():PropertyGridOptions
Returns
Defined in
src/ui/dialogs/entitydialog.tsx:501
getPropertyItems()
protectedgetPropertyItems():PropertyItem[]
Returns
Defined in
src/ui/dialogs/entitydialog.tsx:477
getPropertyItemsData()
protectedgetPropertyItemsData():PropertyItemsData
Returns
Defined in
src/ui/dialogs/entitydialog.tsx:481
getPropertyItemsDataAsync()
protectedgetPropertyItemsDataAsync():Promise<PropertyItemsData>
Returns
Promise<PropertyItemsData>
Defined in
src/ui/dialogs/entitydialog.tsx:496
getRetrieveServiceMethod()
protectedgetRetrieveServiceMethod():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:416
getRowDefinition()
protectedgetRowDefinition():IRowDefinition
Returns
Defined in
src/ui/dialogs/entitydialog.tsx:176
getSaveEntity()
protectedgetSaveEntity():TItem
Returns
TItem
Defined in
src/ui/dialogs/entitydialog.tsx:539
getSaveOptions()
protectedgetSaveOptions(callback,initiator?):ServiceOptions<SaveResponse>
Parameters
callback
(response) => void
initiator?
Returns
Defined in
src/ui/dialogs/entitydialog.tsx:522
getSaveRequest()
protectedgetSaveRequest():SaveRequest<TItem>
Returns
SaveRequest<TItem>
Defined in
src/ui/dialogs/entitydialog.tsx:552
getService()
protectedgetService():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:292
getToolbarButtons()
protectedgetToolbarButtons():ToolButton[]
Returns
Overrides
Defined in
src/ui/dialogs/entitydialog.tsx:586
getUndeleteOptions()
protectedgetUndeleteOptions(callback?):ServiceOptions<UndeleteResponse>
Parameters
callback?
(response) => void
Returns
ServiceOptions<UndeleteResponse>
Defined in
src/ui/dialogs/entitydialog.tsx:675
getUndeleteServiceMethod()
protectedgetUndeleteServiceMethod():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:683
getUpdatePermission()
protectedgetUpdatePermission():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:731
getUpdateServiceMethod()
protectedgetUpdateServiceMethod():string
Returns
string
Defined in
src/ui/dialogs/entitydialog.tsx:518
getValidatorOptions()
protectedgetValidatorOptions():any
Returns
any
Inherited from
BaseDialog.getValidatorOptions
Defined in
src/ui/dialogs/basedialog.tsx:163
handleResponsive()
protectedhandleResponsive():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:226
hasDeletePermission()
protectedhasDeletePermission():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:739
hasInsertPermission()
protectedhasInsertPermission():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:744
hasSavePermission()
protectedhasSavePermission():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:754
hasUpdatePermission()
protectedhasUpdatePermission():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:749
init()
init():
this
Returns
this
Inherited from
Defined in
initDialog()
protectedinitDialog():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:97
initLocalizer()
protectedinitLocalizer():void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:460
initPropertyGrid()
protectedinitPropertyGrid():void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:469
initTabs()
protectedinitTabs():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:219
initToolbar()
protectedinitToolbar():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:152
initUIDialog()
protectedinitUIDialog():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:106
initValidator()
protectedinitValidator():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:167
internalRenderContents()
internalRenderContents():
void
Returns
void
Inherited from
BaseDialog.internalRenderContents
Defined in
isCloneMode()
protectedisCloneMode():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:108
isDeleted()
protectedisDeleted():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:116
isEditMode()
protectedisEditMode():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:112
isNew()
protectedisNew():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:131
isNewOrDeleted()
protectedisNewOrDeleted():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:135
isStaticPanel()
protectedisStaticPanel():boolean
Returns
boolean
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:65
isViewMode()
protectedisViewMode():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:760
legacyTemplateRender()
protectedlegacyTemplateRender():boolean
Returns
boolean
Inherited from
BaseDialog.legacyTemplateRender
Defined in
load()
load(
entityOrId,done,fail?):void
Parameters
entityOrId
any
done
() => void
fail?
(ex) => void
Returns
void
Implementation of
Defined in
src/ui/dialogs/entitydialog.tsx:300
loadById()
loadById(
id,callback?,fail?):void
Parameters
id
any
callback?
(response) => void
fail?
() => void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:420
loadByIdAndOpenDialog()
loadByIdAndOpenDialog(
entityId,asPanel?,callback?,fail?):void
Parameters
entityId
any
asPanel?
boolean
callback?
(response) => void
fail?
() => void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:376
loadByIdHandler()
protectedloadByIdHandler(options,callback,fail):void
Parameters
options
ServiceOptions<RetrieveResponse<TItem>>
callback
(response) => void
fail
() => void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:424
loadEntity()
protectedloadEntity(entity):void
Parameters
entity
TItem
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:357
loadEntityAndOpenDialog()
loadEntityAndOpenDialog(
entity,asPanel?):void
Parameters
entity
TItem
asPanel?
boolean
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:341
loadNewAndOpenDialog()
loadNewAndOpenDialog(
asPanel?):void
Parameters
asPanel?
boolean
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:336
loadResponse()
protectedloadResponse(data):void
Parameters
data
any
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:346
onClose()
onClose(
handler,opt?):void
Attaches a dialog/modal/panel close event handler. See Dialog.close for more info.
Parameters
handler
(result?, e?) => void
opt?
opt.before
boolean
opt.oneOff
boolean
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:139
onDeleteSuccess()
protectedonDeleteSuccess(response):void
Parameters
response
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:173
onDialogClose()
protectedonDialogClose(result?):void
Parameters
result?
string
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:189
onDialogOpen()
protectedonDialogOpen():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:131
onLoadingData()
protectedonLoadingData(data):void
Parameters
data
RetrieveResponse<TItem>
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:390
onOpen()
onOpen(
handler,opt?):void
Attaches a dialog/modal/panel open event handler. See Dialog.open for more info.
Parameters
handler
(e?) => void
opt?
opt.before
boolean
opt.oneOff
boolean
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:144
onSaveSuccess()
protectedonSaveSuccess(response,initiator?):void
Parameters
response
initiator?
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:563
propertyItemsReady()
protectedpropertyItemsReady(itemsData):void
Parameters
itemsData
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:47
reloadById()
protectedreloadById():void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:412
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
Defined in
renderContents()
protectedrenderContents():any
Returns
any
Overrides
Defined in
src/ui/dialogs/entitydialog.tsx:768
resetValidation()
protectedresetValidation():void
Returns
void
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:175
retrieveLocalizations()
protectedretrieveLocalizations():Promise<Record<string,Partial<TItem>>>
Returns
Promise<Record<string, Partial<TItem>>>
Defined in
src/ui/dialogs/entitydialog.tsx:429
save()
protectedsave(callback?,initiator?):boolean|void
Parameters
callback?
(response) => void
initiator?
Returns
boolean | void
Defined in
src/ui/dialogs/entitydialog.tsx:572
save_submitHandler()
protectedsave_submitHandler(callback,initiator):void
Parameters
callback
(response) => void
initiator
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:567
saveHandler()
protectedsaveHandler(options,callback,initiator):void
Parameters
options
callback
(response) => void
initiator
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:578
set_readOnly()
set_readOnly(
value):void
Parameters
value
boolean
Returns
void
Implementation of
Defined in
src/ui/dialogs/entitydialog.tsx:719
showSaveSuccessMessage()
protectedshowSaveSuccessMessage(response,initiator?):void
Parameters
response
initiator?
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:582
syncOrAsyncThen()
protectedsyncOrAsyncThen<T>(syncMethod,asyncMethod,then):void
Type Parameters
• T
Parameters
syncMethod
() => T
asyncMethod
() => PromiseLike<T>
then
(v) => void
Returns
void
Inherited from
Defined in
undelete()
protectedundelete(callback?):void
Parameters
callback?
(response) => void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:687
undeleteHandler()
protectedundeleteHandler(options,callback):void
Parameters
options
ServiceOptions<UndeleteResponse>
callback
(response) => void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:679
updateInterface()
protectedupdateInterface():void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:666
updateTitle()
protectedupdateTitle():void
Returns
void
Defined in
src/ui/dialogs/entitydialog.tsx:104
useAsync()
protecteduseAsync():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:56
useIdPrefix()
protecteduseIdPrefix():IdPrefixType
Returns
Inherited from
Defined in
useViewMode()
protecteduseViewMode():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:764
validateBeforeSave()
protectedvalidateBeforeSave():boolean
Returns
boolean
Defined in
src/ui/dialogs/entitydialog.tsx:510
validateForm()
protectedvalidateForm():boolean
Returns
boolean
Inherited from
Defined in
src/ui/dialogs/basedialog.tsx:179
create()
staticcreate<TWidget,P>(params):TWidget
Type Parameters
• TWidget extends Widget<P>
• P
Parameters
params
CreateWidgetParams<TWidget, P>
Returns
TWidget
Inherited from
Defined in
createDefaultElement()
staticcreateDefaultElement():HTMLDivElement
Returns
HTMLDivElement
Inherited from
BaseDialog.createDefaultElement
Defined in
src/ui/dialogs/basedialog.tsx:15
getWidgetName()
staticgetWidgetName(type):string
Parameters
type
Function
Returns
string