Previous Page Next Page

@serenity-is/corelib / PropertyGrid

Class: PropertyGrid<P>

Defined in: src/ui/widgets/propertygrid.tsx:330

Extends

Type Parameters

P

P extends PropertyGridOptions = PropertyGridOptions

Constructors

Constructor

new PropertyGrid<P>(props): PropertyGrid<P>

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

Parameters

props

WidgetProps<P>

Returns

PropertyGrid<P>

Inherited from

Widget.constructor

Properties

domNode

readonly domNode: HTMLElement

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

Inherited from

Widget.domNode

idPrefix

readonly idPrefix: string

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

Inherited from

Widget.idPrefix

options

protected readonly options: WidgetProps<P>

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

Inherited from

Widget.options

uniqueName

readonly uniqueName: string

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

Inherited from

Widget.uniqueName

[typeInfo]

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

Defined in: src/ui/widgets/propertygrid.tsx:332

Overrides

Widget.[typeInfo]

isComponent

readonly static isComponent: true = true

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

Inherited from

Widget.isComponent

Accessors

element

Get Signature

get element(): Fluent

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

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

Widget.element

props

Get Signature

get props(): WidgetProps<P>

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

Returns

WidgetProps<P>

Inherited from

Widget.props

value

Get Signature

get value(): any

Defined in: src/ui/widgets/propertygrid.tsx:465

Returns

any

Set Signature

set value(val): void

Defined in: src/ui/widgets/propertygrid.tsx:469

Parameters
val

any

Returns

void

Methods

addCssClass()

protected addCssClass(): void

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

Returns

void

Inherited from

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

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

Widget.addValidationRule

afterRender()

protected afterRender(callback): void

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

Parameters

callback

() => void

Returns

void

Inherited from

Widget.afterRender

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

Widget.byId

canModifyItem()

protected canModifyItem(item): boolean

Defined in: src/ui/widgets/propertygrid.tsx:501

Parameters

item

PropertyItem

Returns

boolean

change()

change(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

Widget.change

changeSelect2()

changeSelect2(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

Widget.changeSelect2

deferRender()

protected deferRender(): boolean

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

Returns

boolean

Inherited from

Widget.deferRender

destroy()

destroy(): void

Defined in: src/ui/widgets/propertygrid.tsx:365

Returns

void

Overrides

Widget.destroy

enumerateItems()

enumerateItems(callback): void

Defined in: src/ui/widgets/propertygrid.tsx:396

Parameters

callback

(p1, p2) => void

Returns

void

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

Widget.findById

get_editors()

get_editors(): Widget<any>[]

Defined in: src/ui/widgets/propertygrid.tsx:384

Returns

Widget<any>[]

get_idPrefix()

get_idPrefix(): string

Defined in: src/ui/widgets/propertygrid.tsx:392

Returns

string

get_items()

get_items(): PropertyItem[]

Defined in: src/ui/widgets/propertygrid.tsx:388

Returns

PropertyItem[]

get_mode()

get_mode(): PropertyGridMode

Defined in: src/ui/widgets/propertygrid.tsx:406

Returns

PropertyGridMode

getCssClass()

protected getCssClass(): string

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

Returns

string

Inherited from

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

Widget.getCustomAttribute

getGridField()

getGridField(): Fluent

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

Returns

Fluent

Inherited from

Widget.getGridField

init()

init(): this

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

Returns

this

Inherited from

Widget.init

internalRenderContents()

internalRenderContents(): void

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

Returns

void

Inherited from

Widget.internalRenderContents

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Returns

boolean

Inherited from

Widget.legacyTemplateRender

load()

load(source): void

Defined in: src/ui/widgets/propertygrid.tsx:438

Parameters

source

any

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

Widget.render

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/propertygrid.tsx:336

Returns

any

Overrides

Widget.renderContents

save()

save(target?): any

Defined in: src/ui/widgets/propertygrid.tsx:456

Parameters

target?

any

Returns

any

set_mode()

set_mode(value): void

Defined in: src/ui/widgets/propertygrid.tsx:410

Parameters

value

PropertyGridMode

Returns

void

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

Widget.syncOrAsyncThen

updateFieldElement()

protected updateFieldElement(fieldElement): void

Defined in: src/ui/widgets/propertygrid.tsx:538

Parameters

fieldElement

PropertyFieldElement

Returns

void

updateInterface()

updateInterface(): void

Defined in: src/ui/widgets/propertygrid.tsx:542

Returns

void

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns

IdPrefixType

Inherited from

Widget.useIdPrefix

canModifyItem()

static canModifyItem(item, mode?): boolean

Defined in: src/ui/widgets/propertygrid.tsx:475

Parameters

item

PropertyItem

mode?

PropertyGridMode

Returns

boolean

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

Widget.create

createDefaultElement()

static createDefaultElement(): HTMLElement

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

Returns

HTMLElement

Inherited from

Widget.createDefaultElement

getWidgetName()

static getWidgetName(type): string

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

Parameters

type

Function

Returns

string

Inherited from

Widget.getWidgetName

loadFieldValue()

static loadFieldValue(source, fieldElement, mode?): void

Defined in: src/ui/widgets/propertygrid.tsx:417

Parameters

source

any

fieldElement

PropertyFieldElement

mode?

PropertyGridMode

Returns

void

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

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

Widget.registerEditor

saveFieldValue()

static saveFieldValue(target, fieldElement, canModify?): void

Defined in: src/ui/widgets/propertygrid.tsx:445

Parameters

target

any

fieldElement

PropertyFieldElement

canModify?

boolean

Returns

void

updateFieldElement()

static updateFieldElement(fieldElement, mode?, canModify?): void

Defined in: src/ui/widgets/propertygrid.tsx:505

Parameters

fieldElement

PropertyFieldElement

mode?

PropertyGridMode

canModify?

boolean

Returns

void