@serenity-is/corelib / PropertyPanel

Class: PropertyPanel<TItem, P>

Type parameters

Name
TItem
P

Hierarchy

• TemplatedPanel<P>

  ↳ PropertyPanel

Table of contents

Constructors

• constructor

Properties

• domNode
• idPrefix
• isPanel
• options
• propertyGrid
• responsive
• tabs
• toolbar
• uniqueName
• validator
• typeInfo

Accessors

• element
• props

Methods

• addCssClass
• addValidationRule
• arrange
• byId
• change
• changeSelect2
• destroy
• findById
• getCssClass
• getCustomAttribute
• getFieldElement
• getFormKey
• getGridField
• getPropertyGridOptions
• getPropertyItems
• getSaveEntity
• getTemplate
• getToolbarButtons
• getValidatorOptions
• get_entity
• get_entityId
• init
• initPropertyGrid
• initTabs
• initToolbar
• initValidator
• internalInit
• internalRenderContents
• loadInitialEntity
• render
• renderContents
• resetValidation
• set_entity
• set_entityId
• syncOrAsyncThen
• useIdPrefix
• validateBeforeSave
• validateForm
• create
• createDefaultElement
• getWidgetName

Constructors

constructor

• new PropertyPanel<TItem, P>(props): PropertyPanel<TItem, P>

Type parameters

Name
TItem
P

Parameters

Name	Type
props	WidgetProps<P>

Returns

PropertyPanel<TItem, P>

Overrides

TemplatedPanel.constructor

Defined in

src/ui/widgets/propertypanel.ts:15

Properties

domNode

• Readonly domNode: HTMLElement

Inherited from

TemplatedPanel.domNode

Defined in

src/ui/widgets/widget.ts:18

---

idPrefix

• Readonly idPrefix: string

Inherited from

TemplatedPanel.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

isPanel

• Protected isPanel: boolean

Inherited from

TemplatedPanel.isPanel

Defined in

src/ui/widgets/templatedpanel.ts:42

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

TemplatedPanel.options

Defined in

src/ui/widgets/widget.ts:15

---

propertyGrid

• Protected propertyGrid: PropertyGrid<PropertyGridOptions>

Defined in

src/ui/widgets/propertypanel.ts:107

---

responsive

• Protected responsive: boolean

Inherited from

TemplatedPanel.responsive

Defined in

src/ui/widgets/templatedpanel.ts:43

---

tabs

• Protected tabs: Fluent<HTMLElement>

Inherited from

TemplatedPanel.tabs

Defined in

src/ui/widgets/templatedpanel.ts:39

---

toolbar

• Protected toolbar: Toolbar<ToolbarOptions>

Inherited from

TemplatedPanel.toolbar

Defined in

src/ui/widgets/templatedpanel.ts:40

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

TemplatedPanel.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

validator

• Protected validator: Validator

Inherited from

TemplatedPanel.validator

Defined in

src/ui/widgets/templatedpanel.ts:41

---

typeInfo

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

Inherited from

TemplatedPanel.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

TemplatedPanel.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

TemplatedPanel.props

Defined in

src/ui/widgets/widget.ts:182

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

TemplatedPanel.addCssClass

Defined in

src/ui/widgets/widget.ts:71

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

Name	Type
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string
uniqueName?	string

Returns

void

Inherited from

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

TemplatedPanel.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

arrange

▸ arrange(): void

Returns

void

Inherited from

TemplatedPanel.arrange

Defined in

src/ui/widgets/templatedpanel.ts:45

---

byId

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

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

Fluent<TElement>

Inherited from

TemplatedPanel.byId

Defined in

src/ui/widgets/templatedwidget.ts:8

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

TemplatedPanel.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

TemplatedPanel.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

destroy

▸ destroy(): void

Returns

void

Overrides

TemplatedPanel.destroy

Defined in

src/ui/widgets/propertypanel.ts:22

---

findById

▸ findById<TElement>(id): TElement

Type parameters

Name	Type
TElement	extends HTMLElement = HTMLElement

Parameters

Name	Type
id	string

Returns

TElement

Inherited from

TemplatedPanel.findById

Defined in

src/ui/widgets/templatedwidget.ts:12

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

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

TemplatedPanel.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

TemplatedPanel.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getFormKey

▸ getFormKey(): string

Returns

string

Defined in

src/ui/widgets/propertypanel.ts:48

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

TemplatedPanel.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getPropertyGridOptions

▸ getPropertyGridOptions(): PropertyGridOptions

Returns

PropertyGridOptions

Defined in

src/ui/widgets/propertypanel.ts:64

---

getPropertyItems

▸ getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Defined in

src/ui/widgets/propertypanel.ts:74

---

getSaveEntity

▸ getSaveEntity(): TItem

Returns

TItem

Defined in

src/ui/widgets/propertypanel.ts:79

---

getTemplate

▸ getTemplate(): string

Returns

string

Inherited from

TemplatedPanel.getTemplate

Defined in

src/ui/widgets/templatedwidget.ts:16

---

getToolbarButtons

▸ getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Inherited from

TemplatedPanel.getToolbarButtons

Defined in

src/ui/widgets/templatedpanel.ts:51

---

getValidatorOptions

▸ getValidatorOptions(): any

Returns

any

Inherited from

TemplatedPanel.getValidatorOptions

Defined in

src/ui/widgets/templatedpanel.ts:55

---

get_entity

▸ get_entity(): TItem

Returns

TItem

Defined in

src/ui/widgets/propertypanel.ts:87

---

get_entityId

▸ get_entityId(): any

Returns

any

Defined in

src/ui/widgets/propertypanel.ts:91

---

init

▸ init(): this

Returns

this

Inherited from

TemplatedPanel.init

Defined in

src/ui/widgets/widget.ts:146

---

initPropertyGrid

▸ initPropertyGrid(): void

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:34

---

initTabs

▸ initTabs(): void

Returns

void

Inherited from

TemplatedPanel.initTabs

Defined in

src/ui/widgets/templatedpanel.ts:59

---

initToolbar

▸ initToolbar(): void

Returns

void

Inherited from

TemplatedPanel.initToolbar

Defined in

src/ui/widgets/templatedpanel.ts:66

---

initValidator

▸ initValidator(): void

Returns

void

Inherited from

TemplatedPanel.initValidator

Defined in

src/ui/widgets/templatedpanel.ts:73

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

TemplatedPanel.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

TemplatedPanel.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

loadInitialEntity

▸ loadInitialEntity(): void

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:42

---

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

TemplatedPanel.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): void

Returns

void

Inherited from

TemplatedPanel.renderContents

Defined in

src/ui/widgets/templatedwidget.ts:20

---

resetValidation

▸ resetValidation(): void

Returns

void

Inherited from

TemplatedPanel.resetValidation

Defined in

src/ui/widgets/templatedpanel.ts:81

---

set_entity

▸ set_entity(value): void

Parameters

Name	Type
value	TItem

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:95

---

set_entityId

▸ set_entityId(value): void

Parameters

Name	Type
value	any

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:99

---

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

TemplatedPanel.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

TemplatedPanel.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

validateBeforeSave

▸ validateBeforeSave(): boolean

Returns

boolean

Defined in

src/ui/widgets/propertypanel.ts:103

---

validateForm

▸ validateForm(): boolean

Returns

boolean

Inherited from

TemplatedPanel.validateForm

Defined in

src/ui/widgets/templatedpanel.ts:87

---

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

TemplatedPanel.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

TemplatedPanel.createDefaultElement

Defined in

src/ui/widgets/widget.ts:60

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

TemplatedPanel.getWidgetName

Defined in

src/ui/widgets/widget.ts:95