@serenity-is/corelib / PropertyPanel

Class: PropertyPanel<TItem, TOptions>

Type parameters

Name
TItem
TOptions

Hierarchy

• TemplatedPanel<TOptions>

  ↳ PropertyPanel

Table of contents

Constructors

• constructor

Properties

• _entity
• _entityId
• element
• idPrefix
• isPanel
• options
• propertyGrid
• responsive
• tabs
• toolbar
• uniqueName
• validator
• widgetName

Methods

• addCssClass
• addValidationRule
• arrange
• byId
• change
• changeSelect2
• destroy
• getCssClass
• getFallbackTemplate
• getFormKey
• getGridField
• getPropertyGridOptions
• getPropertyItems
• getSaveEntity
• getTemplate
• getTemplateName
• getToolbarButtons
• getValidatorOptions
• get_entity
• get_entityId
• init
• initPropertyGrid
• initTabs
• initToolbar
• initValidator
• initialize
• loadInitialEntity
• renderContents
• resetValidation
• set_entity
• set_entityId
• useIdPrefix
• validateBeforeSave
• validateForm
• create
• elementFor
• getWidgetName

Constructors

constructor

• new PropertyPanel<TItem, TOptions>(container, options?)

Type parameters

Name
TItem
TOptions

Parameters

Name	Type
container	JQuery
options?	TOptions

Overrides

TemplatedPanel.constructor

Defined in

src/ui/widgets/propertypanel.ts:12

Properties

_entity

• Private _entity: TItem

Defined in

src/ui/widgets/propertypanel.ts:9

---

_entityId

• Private _entityId: any

Defined in

src/ui/widgets/propertypanel.ts:10

---

element

• element: JQuery

Inherited from

TemplatedPanel.element

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Inherited from

TemplatedPanel.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

isPanel

• Protected isPanel: boolean

Inherited from

TemplatedPanel.isPanel

Defined in

src/ui/widgets/templatedpanel.ts:38

---

options

• Protected options: TOptions

Inherited from

TemplatedPanel.options

Defined in

src/ui/widgets/widget.ts:62

---

propertyGrid

• Protected propertyGrid: PropertyGrid

Defined in

src/ui/widgets/propertypanel.ts:113

---

responsive

• Protected responsive: boolean

Inherited from

TemplatedPanel.responsive

Defined in

src/ui/widgets/templatedpanel.ts:39

---

tabs

• Protected tabs: JQuery

Inherited from

TemplatedPanel.tabs

Defined in

src/ui/widgets/templatedpanel.ts:35

---

toolbar

• Protected toolbar: Toolbar

Inherited from

TemplatedPanel.toolbar

Defined in

src/ui/widgets/templatedpanel.ts:36

---

uniqueName

• Protected uniqueName: string

Inherited from

TemplatedPanel.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

validator

• Protected validator: Validator

Inherited from

TemplatedPanel.validator

Defined in

src/ui/widgets/templatedpanel.ts:37

---

widgetName

• Protected widgetName: string

Inherited from

TemplatedPanel.widgetName

Defined in

src/ui/widgets/widget.ts:63

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

TemplatedPanel.addCssClass

Defined in

src/ui/widgets/widget.ts:100

---

addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

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

Returns

JQuery

Inherited from

TemplatedPanel.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

arrange

▸ arrange(): void

Returns

void

Inherited from

TemplatedPanel.arrange

Defined in

src/ui/widgets/templatedpanel.ts:41

---

byId

▸ Protected byId(id): JQuery

Parameters

Name	Type
id	string

Returns

JQuery

Inherited from

TemplatedPanel.byId

Defined in

src/ui/widgets/templatedwidget.ts:10

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedPanel.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedPanel.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedPanel.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

TemplatedPanel.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

destroy

▸ destroy(): void

Returns

void

Overrides

TemplatedPanel.destroy

Defined in

src/ui/widgets/propertypanel.ts:19

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

TemplatedPanel.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getFallbackTemplate

▸ Protected getFallbackTemplate(): string

Returns

string

Inherited from

TemplatedPanel.getFallbackTemplate

Defined in

src/ui/widgets/templatedwidget.ts:79

---

getFormKey

▸ Protected getFormKey(): string

Returns

string

Defined in

src/ui/widgets/propertypanel.ts:49

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

TemplatedPanel.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getPropertyGridOptions

▸ Protected getPropertyGridOptions(): PropertyGridOptions

Returns

PropertyGridOptions

Defined in

src/ui/widgets/propertypanel.ts:70

---

getPropertyItems

▸ Protected getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Defined in

src/ui/widgets/propertypanel.ts:80

---

getSaveEntity

▸ Protected getSaveEntity(): TItem

Returns

TItem

Defined in

src/ui/widgets/propertypanel.ts:85

---

getTemplate

▸ Protected getTemplate(): string

Returns

string

Inherited from

TemplatedPanel.getTemplate

Defined in

src/ui/widgets/templatedwidget.ts:83

---

getTemplateName

▸ Protected getTemplateName(): string

Returns

string

Inherited from

TemplatedPanel.getTemplateName

Defined in

src/ui/widgets/templatedwidget.ts:31

---

getToolbarButtons

▸ Protected getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Inherited from

TemplatedPanel.getToolbarButtons

Defined in

src/ui/widgets/templatedpanel.ts:47

---

getValidatorOptions

▸ Protected getValidatorOptions(): ValidationOptions

Returns

ValidationOptions

Inherited from

TemplatedPanel.getValidatorOptions

Defined in

src/ui/widgets/templatedpanel.ts:51

---

get_entity

▸ Protected get_entity(): TItem

Returns

TItem

Defined in

src/ui/widgets/propertypanel.ts:93

---

get_entityId

▸ Protected get_entityId(): any

Returns

any

Defined in

src/ui/widgets/propertypanel.ts:97

---

init

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

Parameters

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

Returns

PropertyPanel<TItem, TOptions>

Inherited from

TemplatedPanel.init

Defined in

src/ui/widgets/widget.ts:179

---

initPropertyGrid

▸ Protected initPropertyGrid(): void

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:31

---

initTabs

▸ Protected initTabs(): void

Returns

void

Inherited from

TemplatedPanel.initTabs

Defined in

src/ui/widgets/templatedpanel.ts:55

---

initToolbar

▸ Protected initToolbar(): void

Returns

void

Inherited from

TemplatedPanel.initToolbar

Defined in

src/ui/widgets/templatedpanel.ts:63

---

initValidator

▸ Protected initValidator(): void

Returns

void

Inherited from

TemplatedPanel.initValidator

Defined in

src/ui/widgets/templatedpanel.ts:72

---

initialize

▸ initialize(): void

Returns

void

Inherited from

TemplatedPanel.initialize

Defined in

src/ui/widgets/widget.ts:176

---

loadInitialEntity

▸ Protected loadInitialEntity(): void

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:43

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

TemplatedPanel.renderContents

Defined in

src/ui/widgets/templatedwidget.ts:110

---

resetValidation

▸ Protected resetValidation(): void

Returns

void

Inherited from

TemplatedPanel.resetValidation

Defined in

src/ui/widgets/templatedpanel.ts:80

---

set_entity

▸ Protected set_entity(value): void

Parameters

Name	Type
value	TItem

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:101

---

set_entityId

▸ Protected set_entityId(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:105

---

useIdPrefix

▸ Protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

TemplatedPanel.useIdPrefix

Defined in

src/ui/widgets/templatedwidget.ts:131

---

validateBeforeSave

▸ Protected validateBeforeSave(): boolean

Returns

boolean

Defined in

src/ui/widgets/propertypanel.ts:109

---

validateForm

▸ Protected validateForm(): boolean

Returns

boolean

Inherited from

TemplatedPanel.validateForm

Defined in

src/ui/widgets/templatedpanel.ts:86

---

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

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

TemplatedPanel.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

TemplatedPanel.getWidgetName

Defined in

src/ui/widgets/widget.ts:124