@serenity-is/corelib / PropertyDialog

Class: PropertyDialog<TItem, TOptions>

Type parameters

Name
TItem
TOptions

Hierarchy

• TemplatedDialog<TOptions>

  ↳ PropertyDialog

Table of contents

Constructors

• constructor

Properties

• element
• entity
• entityId
• idPrefix
• options
• propertyGrid
• propertyItemsData
• tabs
• toolbar
• uniqueName
• validator
• widgetName
• bootstrapModal

Accessors

• dialogTitle
• isMarkedAsPanel
• isResponsive

Methods

• addCssClass
• addValidationRule
• afterInit
• arrange
• byId
• cancelClick
• change
• changeSelect2
• destroy
• dialogClose
• dialogOpen
• getCssClass
• getDialogButtons
• getDialogOptions
• getDialogTitle
• getFallbackTemplate
• getFormKey
• getGridField
• getModalOptions
• getPropertyGridOptions
• getPropertyItems
• getPropertyItemsData
• getPropertyItemsDataAsync
• getSaveEntity
• getTemplate
• getTemplateName
• getToolbarButtons
• getValidatorOptions
• get_entity
• get_entityId
• handleResponsive
• init
• initAsync
• initDialog
• initModal
• initPropertyGrid
• initSync
• initTabs
• initToolbar
• initValidator
• initialize
• internalInit
• loadInitialEntity
• okClick
• okClickValidated
• onDialogClose
• onDialogOpen
• renderContents
• resetValidation
• set_dialogTitle
• set_entity
• set_entityId
• updateTitle
• useAsync
• useIdPrefix
• validateBeforeSave
• validateForm
• closePanel
• create
• elementFor
• getWidgetName
• openPanel

Constructors

constructor

• new PropertyDialog<TItem, TOptions>(opt?)

Type parameters

Name
TItem
TOptions

Parameters

Name	Type
opt?	TOptions

Overrides

TemplatedDialog.constructor

Defined in

src/ui/dialogs/propertydialog.ts:12

Properties

element

• element: JQuery

Inherited from

TemplatedDialog.element

Defined in

src/ui/widgets/widget.ts:61

---

entity

• Protected entity: TItem

Defined in

src/ui/dialogs/propertydialog.ts:8

---

entityId

• Protected entityId: any

Defined in

src/ui/dialogs/propertydialog.ts:9

---

idPrefix

• Readonly idPrefix: string

Inherited from

TemplatedDialog.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

options

• Protected options: TOptions

Inherited from

TemplatedDialog.options

Defined in

src/ui/widgets/widget.ts:62

---

propertyGrid

• Protected propertyGrid: PropertyGrid

Defined in

src/ui/dialogs/propertydialog.ts:204

---

propertyItemsData

• Protected propertyItemsData: PropertyItemsData

Defined in

src/ui/dialogs/propertydialog.ts:10

---

tabs

• Protected tabs: JQuery

Inherited from

TemplatedDialog.tabs

Defined in

src/ui/dialogs/templateddialog.ts:12

---

toolbar

• Protected toolbar: Toolbar

Inherited from

TemplatedDialog.toolbar

Defined in

src/ui/dialogs/templateddialog.ts:13

---

uniqueName

• Protected uniqueName: string

Inherited from

TemplatedDialog.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

validator

• Protected validator: Validator

Inherited from

TemplatedDialog.validator

Defined in

src/ui/dialogs/templateddialog.ts:14

---

widgetName

• Protected widgetName: string

Inherited from

TemplatedDialog.widgetName

Defined in

src/ui/widgets/widget.ts:63

---

bootstrapModal

▪ Static bootstrapModal: boolean

Inherited from

TemplatedDialog.bootstrapModal

Defined in

src/ui/dialogs/templateddialog.ts:274

Accessors

dialogTitle

• get dialogTitle(): string

Returns

string

Inherited from

TemplatedDialog.dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:360

• set dialogTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

TemplatedDialog.dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:395

---

isMarkedAsPanel

• Private get isMarkedAsPanel(): boolean

Returns

boolean

Inherited from

TemplatedDialog.isMarkedAsPanel

Defined in

src/ui/dialogs/templateddialog.ts:26

---

isResponsive

• Private get isResponsive(): boolean

Returns

boolean

Inherited from

TemplatedDialog.isResponsive

Defined in

src/ui/dialogs/templateddialog.ts:32

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

TemplatedDialog.addCssClass

Defined in

src/ui/dialogs/templateddialog.ts:315

---

addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

Name	Type
eventClass	string
rule	(p1: JQuery) => string

Returns

JQuery

Inherited from

TemplatedDialog.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

afterInit

▸ Protected afterInit(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:38

---

arrange

▸ arrange(): void

Returns

void

Inherited from

TemplatedDialog.arrange

Defined in

src/ui/dialogs/templateddialog.ts:291

---

byId

▸ Protected byId(id): JQuery

Parameters

Name	Type
id	string

Returns

JQuery

Inherited from

TemplatedDialog.byId

Defined in

src/ui/widgets/templatedwidget.ts:10

---

cancelClick

▸ Protected cancelClick(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:89

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedDialog.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedDialog.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedDialog.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedDialog.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

destroy

▸ destroy(): void

Returns

void

Overrides

TemplatedDialog.destroy

Defined in

src/ui/dialogs/propertydialog.ts:45

---

dialogClose

▸ dialogClose(): void

Returns

void

Inherited from

TemplatedDialog.dialogClose

Defined in

src/ui/dialogs/templateddialog.ts:350

---

dialogOpen

▸ dialogOpen(asPanel?): void

Parameters

Name	Type
asPanel?	boolean

Returns

void

Inherited from

TemplatedDialog.dialogOpen

Defined in

src/ui/dialogs/templateddialog.ts:244

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

TemplatedDialog.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getDialogButtons

▸ Protected getDialogButtons(): DialogButton[]

Returns

DialogButton[]

Overrides

TemplatedDialog.getDialogButtons

Defined in

src/ui/dialogs/propertydialog.ts:65

---

getDialogOptions

▸ Protected getDialogOptions(): any

Returns

any

Overrides

TemplatedDialog.getDialogOptions

Defined in

src/ui/dialogs/propertydialog.ts:59

---

getDialogTitle

▸ Protected getDialogTitle(): string

Returns

string

Inherited from

TemplatedDialog.getDialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:346

---

getFallbackTemplate

▸ Protected getFallbackTemplate(): string

Returns

string

Overrides

TemplatedDialog.getFallbackTemplate

Defined in

src/ui/dialogs/propertydialog.ts:206

---

getFormKey

▸ Protected getFormKey(): string

Returns

string

Defined in

src/ui/dialogs/propertydialog.ts:105

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

TemplatedDialog.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getModalOptions

▸ Protected getModalOptions(): ModalOptions

Returns

ModalOptions

Inherited from

TemplatedDialog.getModalOptions

Defined in

src/ui/dialogs/templateddialog.ts:153

---

getPropertyGridOptions

▸ Protected getPropertyGridOptions(): PropertyGridOptions

Returns

PropertyGridOptions

Defined in

src/ui/dialogs/propertydialog.ts:127

---

getPropertyItems

▸ Protected getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Defined in

src/ui/dialogs/propertydialog.ts:137

---

getPropertyItemsData

▸ Protected getPropertyItemsData(): PropertyItemsData

Returns

PropertyItemsData

Defined in

src/ui/dialogs/propertydialog.ts:141

---

getPropertyItemsDataAsync

▸ Protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Returns

Promise<PropertyItemsData>

Defined in

src/ui/dialogs/propertydialog.ts:160

---

getSaveEntity

▸ Protected getSaveEntity(): TItem

Returns

TItem

Defined in

src/ui/dialogs/propertydialog.ts:169

---

getTemplate

▸ Protected getTemplate(): string

Returns

string

Inherited from

TemplatedDialog.getTemplate

Defined in

src/ui/widgets/templatedwidget.ts:83

---

getTemplateName

▸ Protected getTemplateName(): string

Returns

string

Inherited from

TemplatedDialog.getTemplateName

Defined in

src/ui/widgets/templatedwidget.ts:31

---

getToolbarButtons

▸ Protected getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Inherited from

TemplatedDialog.getToolbarButtons

Defined in

src/ui/dialogs/templateddialog.ts:220

---

getValidatorOptions

▸ Protected getValidatorOptions(): ValidationOptions

Returns

ValidationOptions

Inherited from

TemplatedDialog.getValidatorOptions

Defined in

src/ui/dialogs/templateddialog.ts:224

---

get_entity

▸ Protected get_entity(): TItem

Returns

TItem

Defined in

src/ui/dialogs/propertydialog.ts:181

---

get_entityId

▸ Protected get_entityId(): any

Returns

any

Defined in

src/ui/dialogs/propertydialog.ts:189

---

handleResponsive

▸ Protected handleResponsive(): void

Returns

void

Inherited from

TemplatedDialog.handleResponsive

Defined in

src/ui/dialogs/templateddialog.ts:426

---

init

▸ init(action?): PropertyDialog<TItem, TOptions>

Parameters

Name	Type
action?	(widget: any) => void

Returns

PropertyDialog<TItem, TOptions>

Inherited from

TemplatedDialog.init

Defined in

src/ui/widgets/widget.ts:179

---

initAsync

▸ Protected initAsync(): Promise<void>

Returns

Promise<void>

Defined in

src/ui/dialogs/propertydialog.ts:32

---

initDialog

▸ Protected initDialog(): void

Returns

void

Inherited from

TemplatedDialog.initDialog

Defined in

src/ui/dialogs/templateddialog.ts:104

---

initModal

▸ Protected initModal(): void

Returns

void

Inherited from

TemplatedDialog.initModal

Defined in

src/ui/dialogs/templateddialog.ts:162

---

initPropertyGrid

▸ Protected initPropertyGrid(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:93

---

initSync

▸ Protected initSync(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:26

---

initTabs

▸ Protected initTabs(): void

Returns

void

Inherited from

TemplatedDialog.initTabs

Defined in

src/ui/dialogs/templateddialog.ts:417

---

initToolbar

▸ Protected initToolbar(): void

Returns

void

Inherited from

TemplatedDialog.initToolbar

Defined in

src/ui/dialogs/templateddialog.ts:203

---

initValidator

▸ Protected initValidator(): void

Returns

void

Inherited from

TemplatedDialog.initValidator

Defined in

src/ui/dialogs/templateddialog.ts:228

---

initialize

▸ initialize(): void

Returns

void

Inherited from

TemplatedDialog.initialize

Defined in

src/ui/widgets/widget.ts:176

---

internalInit

▸ internalInit(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:21

---

loadInitialEntity

▸ Protected loadInitialEntity(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:177

---

okClick

▸ Protected okClick(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:77

---

okClickValidated

▸ Protected okClickValidated(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:85

---

onDialogClose

▸ Protected onDialogClose(): void

Returns

void

Inherited from

TemplatedDialog.onDialogClose

Defined in

src/ui/dialogs/templateddialog.ts:297

---

onDialogOpen

▸ Protected onDialogOpen(): void

Returns

void

Inherited from

TemplatedDialog.onDialogOpen

Defined in

src/ui/dialogs/templateddialog.ts:284

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

TemplatedDialog.renderContents

Defined in

src/ui/widgets/templatedwidget.ts:110

---

resetValidation

▸ Protected resetValidation(): void

Returns

void

Inherited from

TemplatedDialog.resetValidation

Defined in

src/ui/dialogs/templateddialog.ts:236

---

set_dialogTitle

▸ set_dialogTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

TemplatedDialog.set_dialogTitle

Defined in

src/ui/dialogs/templateddialog.ts:413

---

set_entity

▸ Protected set_entity(value): void

Parameters

Name	Type
value	TItem

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:185

---

set_entityId

▸ Protected set_entityId(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:193

---

updateTitle

▸ Protected updateTitle(): void

Returns

void

Defined in

src/ui/dialogs/propertydialog.ts:201

---

useAsync

▸ Protected useAsync(): boolean

Returns

boolean

Defined in

src/ui/dialogs/propertydialog.ts:41

---

useIdPrefix

▸ Protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

TemplatedDialog.useIdPrefix

Defined in

src/ui/widgets/templatedwidget.ts:131

---

validateBeforeSave

▸ Protected validateBeforeSave(): boolean

Returns

boolean

Defined in

src/ui/dialogs/propertydialog.ts:197

---

validateForm

▸ Protected validateForm(): boolean

Returns

boolean

Inherited from

TemplatedDialog.validateForm

Defined in

src/ui/dialogs/templateddialog.ts:240

---

closePanel

▸ Static closePanel(element, e?): void

Parameters

Name	Type
element	JQuery
e?	JQueryEventObject

Returns

void

Inherited from

TemplatedDialog.closePanel

Defined in

src/ui/dialogs/templateddialog.ts:280

---

create

▸ Static create<TWidget, TOpt>(params): TWidget

Type parameters

Name	Type
TWidget	extends Widget<TOpt, TWidget>
TOpt	TOpt

Parameters

Name	Type
params	CreateWidgetParams<TWidget, TOpt>

Returns

TWidget

Inherited from

TemplatedDialog.create

Defined in

src/ui/widgets/widget.ts:153

---

elementFor

▸ Static elementFor<TWidget>(editorType): JQuery

Type parameters

Name
TWidget

Parameters

Name	Type
editorType	(...args: any[]) => TWidget

Returns

JQuery

Inherited from

TemplatedDialog.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

TemplatedDialog.getWidgetName

Defined in

src/ui/widgets/widget.ts:124

---

openPanel

▸ Static openPanel(element, uniqueName): void

Parameters

Name	Type
element	JQuery
uniqueName	string

Returns

void

Inherited from

TemplatedDialog.openPanel

Defined in

src/ui/dialogs/templateddialog.ts:276