Serenity Guide

Previous Page Next Page

@serenity-is/corelib / PropertyPanel

Class: PropertyPanel<TItem, P>

Defined in: src/ui/widgets/propertypanel.ts:7

Extends

BasePanel<P>

Type Parameters

TItem

TItem

P

P

Constructors

Constructor

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

Defined in: src/ui/widgets/propertypanel.ts:13

Parameters

props

WidgetProps<P>

Returns

PropertyPanel<TItem, P>

Overrides

BasePanel.constructor

Properties

domNode

readonly domNode: HTMLElement

Defined in: src/ui/widgets/widget.ts:14

Inherited from

BasePanel.domNode

idPrefix

readonly idPrefix: string

Defined in: src/ui/widgets/widget.ts:13

Inherited from

BasePanel.idPrefix

isPanel

protected isPanel: boolean

Defined in: src/ui/widgets/basepanel.ts:39

Inherited from

BasePanel.isPanel

options

protected readonly options: WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:11

Inherited from

BasePanel.options

propertyGrid

protected propertyGrid: PropertyGrid

Defined in: src/ui/widgets/propertypanel.ts:101

responsive

protected responsive: boolean

Defined in: src/ui/widgets/basepanel.ts:40

Inherited from

BasePanel.responsive

tabs

protected tabs: Fluent

Defined in: src/ui/widgets/basepanel.ts:36

Inherited from

BasePanel.tabs

protected toolbar: Toolbar

Defined in: src/ui/widgets/basepanel.ts:37

Inherited from

BasePanel.toolbar

uniqueName

readonly uniqueName: string

Defined in: src/ui/widgets/widget.ts:12

Inherited from

BasePanel.uniqueName

validator

protected validator: Validator

Defined in: src/ui/widgets/basepanel.ts:38

Inherited from

BasePanel.validator

[typeInfo]

static [typeInfo]: ClassTypeInfo<"Serenity.">

Defined in: src/ui/widgets/propertypanel.ts:8

Overrides

BasePanel.[typeInfo]

isComponent

readonly static isComponent: true = true

Defined in: src/ui/widgets/widget.ts:219

Inherited from

BasePanel.isComponent

Accessors

element

Get Signature

get element(): Fluent

Defined in: src/ui/widgets/widget.ts:59

Returns a Fluent(this.domNode) object

Returns

Inherited from

BasePanel.element

entity

Get Signature

get entity(): TItem

Defined in: src/ui/widgets/propertypanel.ts:81

Returns

TItem

Set Signature

set entity(value): void

Defined in: src/ui/widgets/propertypanel.ts:89

Parameters

value

TItem

Returns

void

entityId

Get Signature

get entityId(): any

Defined in: src/ui/widgets/propertypanel.ts:85

Returns

any

Set Signature

set entityId(value): void

Defined in: src/ui/widgets/propertypanel.ts:93

Parameters

value

any

Returns

void

props

Get Signature

get props(): WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:203

Returns

WidgetProps<P>

Inherited from

BasePanel.props

Methods

addCssClass()

protected addCssClass(): void

Defined in: src/ui/widgets/widget.ts:63

Returns

void

Inherited from

BasePanel.addCssClass

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Defined in: src/ui/widgets/widget.ts:95

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

BasePanel.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

Defined in: src/ui/widgets/widget.ts:96

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

BasePanel.addValidationRule

afterRender()

protected afterRender(callback): void

Defined in: src/ui/widgets/widget.ts:142

Parameters

callback

() => void

Returns

void

Inherited from

BasePanel.afterRender

arrange()

arrange(): void

Defined in: src/ui/widgets/basepanel.ts:42

Returns

void

Inherited from

BasePanel.arrange

byId()

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

Defined in: src/ui/widgets/widget.ts:102

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

BasePanel.byId

change()

change(handler): void

Defined in: src/ui/widgets/widget.ts:114

Parameters

handler

(e) => void

Returns

void

Inherited from

BasePanel.change

changeSelect2()

changeSelect2(handler): void

Defined in: src/ui/widgets/widget.ts:118

Parameters

handler

(e) => void

Returns

void

Inherited from

BasePanel.changeSelect2

deferRender()

protected deferRender(): boolean

Defined in: src/ui/widgets/widget.ts:67

Returns

boolean

Inherited from

BasePanel.deferRender

destroy()

destroy(): void

Defined in: src/ui/widgets/propertypanel.ts:20

Returns

void

Overrides

BasePanel.destroy

findById()

protected findById<TElement>(id): TElement

Defined in: src/ui/widgets/widget.ts:106

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

BasePanel.findById

getCssClass()

protected getCssClass(): string

Defined in: src/ui/widgets/widget.ts:71

Returns

string

Inherited from

BasePanel.getCssClass

getCustomAttribute()

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

Defined in: src/ui/widgets/widget.ts:138

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

BasePanel.getCustomAttribute

getFormKey()

protected getFormKey(): string

Defined in: src/ui/widgets/propertypanel.ts:47

Returns

string

getGridField()

getGridField(): Fluent

Defined in: src/ui/widgets/widget.ts:110

Returns

Inherited from

BasePanel.getGridField

getPropertyGridOptions()

protected getPropertyGridOptions(): PropertyGridOptions

Defined in: src/ui/widgets/propertypanel.ts:59

Returns

PropertyGridOptions

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

Defined in: src/ui/widgets/propertypanel.ts:68

Returns

PropertyItem[]

getSaveEntity()

protected getSaveEntity(): TItem

Defined in: src/ui/widgets/propertypanel.ts:73

Returns

TItem

getToolbarButtons()

protected getToolbarButtons(): ToolButton[]

Defined in: src/ui/widgets/basepanel.ts:48

Returns

Inherited from

BasePanel.getToolbarButtons

getValidatorOptions()

protected getValidatorOptions(): any

Defined in: src/ui/widgets/basepanel.ts:52

Returns

any

Inherited from

BasePanel.getValidatorOptions

init()

init(): this

Defined in: src/ui/widgets/widget.ts:153

Returns

this

Inherited from

BasePanel.init

initPropertyGrid()

protected initPropertyGrid(): void

Defined in: src/ui/widgets/propertypanel.ts:33

Returns

void

initTabs()

protected initTabs(): void

Defined in: src/ui/widgets/basepanel.ts:56

Returns

void

Inherited from

BasePanel.initTabs

initToolbar()

protected initToolbar(): void

Defined in: src/ui/widgets/basepanel.ts:63

Returns

void

Inherited from

BasePanel.initToolbar

initValidator()

protected initValidator(): void

Defined in: src/ui/widgets/basepanel.ts:70

Returns

void

Inherited from

BasePanel.initValidator

internalRenderContents()

internalRenderContents(): void

Defined in: src/ui/widgets/widget.ts:173

Returns

void

Inherited from

BasePanel.internalRenderContents

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Defined in: src/ui/widgets/widget.ts:190

Returns

boolean

Inherited from

BasePanel.legacyTemplateRender

loadInitialEntity()

protected loadInitialEntity(): void

Defined in: src/ui/widgets/propertypanel.ts:41

Returns

void

render()

render(): any

Defined in: src/ui/widgets/widget.ts:163

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

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/widget.ts:184

Returns

any

Inherited from

BasePanel.renderContents

resetValidation()

protected resetValidation(): void

Defined in: src/ui/widgets/basepanel.ts:78

Returns

void

Inherited from

BasePanel.resetValidation

syncOrAsyncThen()

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

Defined in: src/ui/widgets/widget.ts:207

Type Parameters

T

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

BasePanel.syncOrAsyncThen

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Defined in: src/ui/widgets/widget.ts:214

Returns

Inherited from

BasePanel.useIdPrefix

validateBeforeSave()

protected validateBeforeSave(): boolean

Defined in: src/ui/widgets/propertypanel.ts:97

Returns

boolean

validateForm()

protected validateForm(): boolean

Defined in: src/ui/widgets/basepanel.ts:84

Returns

boolean

Inherited from

BasePanel.validateForm

create()

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

Defined in: src/ui/widgets/widget.ts:126

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

BasePanel.create

createDefaultElement()

static createDefaultElement(): HTMLElement

Defined in: src/ui/widgets/widget.ts:52

Returns

HTMLElement

Inherited from

BasePanel.createDefaultElement

getWidgetName()

static getWidgetName(type): string

Defined in: src/ui/widgets/widget.ts:91

Parameters

type

Function

Returns

string

Inherited from

BasePanel.getWidgetName

registerClass()

protected static registerClass<TypeName>(typeName, intfAndAttr?): ClassTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:221

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

ClassTypeInfo<TypeName>

Inherited from

BasePanel.registerClass

registerEditor()

protected static registerEditor<TypeName>(typeName, intfAndAttr?): EditorTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:230

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

EditorTypeInfo<TypeName>

Inherited from

BasePanel.registerEditor

Previous Page Next Page