@serenity-is/corelib / PropertyPanel

Class: PropertyPanel<TItem, P>

Extends

• BasePanel<P>

Type Parameters

• TItem

• P

Constructors

new PropertyPanel()

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

Parameters

props

WidgetProps<P>

Returns

PropertyPanel<TItem, P>

Overrides

BasePanel.constructor

Defined in

src/ui/widgets/propertypanel.ts:15

Properties

domNode

readonly domNode: HTMLElement

Inherited from

BasePanel.domNode

Defined in

src/ui/widgets/widget.ts:17

---

idPrefix

readonly idPrefix: string

Inherited from

BasePanel.idPrefix

Defined in

src/ui/widgets/widget.ts:16

---

isPanel

protected isPanel: boolean

Inherited from

BasePanel.isPanel

Defined in

src/ui/widgets/basepanel.ts:39

---

options

protected readonly options: WidgetProps<P>

Inherited from

BasePanel.options

Defined in

src/ui/widgets/widget.ts:14

---

propertyGrid

protected propertyGrid: PropertyGrid<PropertyGridOptions>

Defined in

src/ui/widgets/propertypanel.ts:106

---

responsive

protected responsive: boolean

Inherited from

BasePanel.responsive

Defined in

src/ui/widgets/basepanel.ts:40

---

tabs

protected tabs: Fluent<HTMLElement>

Inherited from

BasePanel.tabs

Defined in

src/ui/widgets/basepanel.ts:36

---

toolbar

protected toolbar: Toolbar<ToolbarOptions>

Inherited from

BasePanel.toolbar

Defined in

src/ui/widgets/basepanel.ts:37

---

uniqueName

readonly uniqueName: string

Inherited from

BasePanel.uniqueName

Defined in

src/ui/widgets/widget.ts:15

---

validator

protected validator: Validator

Inherited from

BasePanel.validator

Defined in

src/ui/widgets/basepanel.ts:38

---

isComponent

readonly static isComponent: true = true

Inherited from

BasePanel.isComponent

Defined in

src/ui/widgets/widget.ts:223

---

typeInfo

static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

BasePanel.typeInfo

Defined in

src/ui/widgets/widget.ts:11

Accessors

element

Get Signature

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

BasePanel.element

Defined in

src/ui/widgets/widget.ts:63

---

entity

Get Signature

get entity(): TItem

Returns

TItem

Set Signature

set entity(value): void

Parameters

value

TItem

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:86

---

entityId

Get Signature

get entityId(): any

Returns

any

Set Signature

set entityId(value): void

Parameters

value

any

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:90

---

props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

BasePanel.props

Defined in

src/ui/widgets/widget.ts:207

Methods

addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

BasePanel.addCssClass

Defined in

src/ui/widgets/widget.ts:67

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

BasePanel.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

Call Signature

addValidationRule(uniqueName, rule): void

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

BasePanel.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

BasePanel.afterRender

Defined in

src/ui/widgets/widget.ts:146

---

arrange()

arrange(): void

Returns

void

Inherited from

BasePanel.arrange

Defined in

src/ui/widgets/basepanel.ts:42

---

byId()

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

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

BasePanel.byId

Defined in

src/ui/widgets/widget.ts:106

---

change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

BasePanel.change

Defined in

src/ui/widgets/widget.ts:118

---

changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

BasePanel.changeSelect2

Defined in

src/ui/widgets/widget.ts:122

---

deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

BasePanel.deferRender

Defined in

src/ui/widgets/widget.ts:71

---

destroy()

destroy(): void

Returns

void

Overrides

BasePanel.destroy

Defined in

src/ui/widgets/propertypanel.ts:22

---

findById()

protected findById<TElement>(id): TElement

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

BasePanel.findById

Defined in

src/ui/widgets/widget.ts:110

---

getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

BasePanel.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCustomAttribute()

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

Type Parameters

• TAttr

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

BasePanel.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142

---

getFormKey()

protected getFormKey(): string

Returns

string

Defined in

src/ui/widgets/propertypanel.ts:48

---

getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

BasePanel.getGridField

Defined in

src/ui/widgets/widget.ts:114

---

getPropertyGridOptions()

protected getPropertyGridOptions(): PropertyGridOptions

Returns

PropertyGridOptions

Defined in

src/ui/widgets/propertypanel.ts:64

---

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Defined in

src/ui/widgets/propertypanel.ts:73

---

getSaveEntity()

protected getSaveEntity(): TItem

Returns

TItem

Defined in

src/ui/widgets/propertypanel.ts:78

---

getToolbarButtons()

protected getToolbarButtons(): ToolButton[]

Returns

ToolButton[]

Inherited from

BasePanel.getToolbarButtons

Defined in

src/ui/widgets/basepanel.ts:48

---

getValidatorOptions()

protected getValidatorOptions(): any

Returns

any

Inherited from

BasePanel.getValidatorOptions

Defined in

src/ui/widgets/basepanel.ts:52

---

init()

init(): this

Returns

this

Inherited from

BasePanel.init

Defined in

src/ui/widgets/widget.ts:157

---

initPropertyGrid()

protected initPropertyGrid(): void

Returns

void

Defined in

src/ui/widgets/propertypanel.ts:34

---

initTabs()

protected initTabs(): void

Returns

void

Inherited from

BasePanel.initTabs

Defined in

src/ui/widgets/basepanel.ts:56

---

initToolbar()

protected initToolbar(): void

Returns

void

Inherited from

BasePanel.initToolbar

Defined in

src/ui/widgets/basepanel.ts:63

---

initValidator()

protected initValidator(): void

Returns

void

Inherited from

BasePanel.initValidator

Defined in

src/ui/widgets/basepanel.ts:70

---

internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

BasePanel.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

BasePanel.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194

---

loadInitialEntity()

protected 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

BasePanel.render

Defined in

src/ui/widgets/widget.ts:167

---

renderContents()

protected renderContents(): any

Returns

any

Inherited from

BasePanel.renderContents

Defined in

src/ui/widgets/widget.ts:188

---

resetValidation()

protected resetValidation(): void

Returns

void

Inherited from

BasePanel.resetValidation

Defined in

src/ui/widgets/basepanel.ts:78

---

syncOrAsyncThen()

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

Type Parameters

• T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

BasePanel.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

BasePanel.useIdPrefix

Defined in

src/ui/widgets/widget.ts:218

---

validateBeforeSave()

protected validateBeforeSave(): boolean

Returns

boolean

Defined in

src/ui/widgets/propertypanel.ts:102

---

validateForm()

protected validateForm(): boolean

Returns

boolean

Inherited from

BasePanel.validateForm

Defined in

src/ui/widgets/basepanel.ts:84

---

create()

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

Type Parameters

• TWidget extends Widget<P>

• P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

BasePanel.create

Defined in

src/ui/widgets/widget.ts:130

---

createDefaultElement()

static createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

BasePanel.createDefaultElement

Defined in

src/ui/widgets/widget.ts:56

---

getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

BasePanel.getWidgetName

Defined in

src/ui/widgets/widget.ts:95