@serenity-is/corelib / PropertyGrid

Class: PropertyGrid

Hierarchy

• Widget<PropertyGridOptions>

  ↳ PropertyGrid

Table of contents

Constructors

• constructor

Properties

• editors
• element
• idPrefix
• items
• options
• uniqueName
• widgetName

Accessors

• value

Methods

• addCssClass
• addValidationRule
• canModifyItem
• categoryLinkClick
• change
• changeSelect2
• createCategoryDiv
• createCategoryLinks
• createField
• createItems
• destroy
• determineText
• enumerateItems
• getCategoryOrder
• getCssClass
• getGridField
• get_editors
• get_idPrefix
• get_items
• get_mode
• init
• initialize
• load
• renderContents
• save
• set_mode
• updateInterface
• create
• elementFor
• getWidgetName
• loadEditorValue
• saveEditorValue
• setMaxLength
• setReadOnly
• setReadonly
• setRequired

Constructors

constructor

• new PropertyGrid(div, opt)

Parameters

Name	Type
div	JQuery
opt	PropertyGridOptions

Overrides

Widget.constructor

Defined in

src/ui/widgets/propertygrid.ts:15

Properties

editors

• Private editors: Widget<any>[]

Defined in

src/ui/widgets/propertygrid.ts:11

---

element

• element: JQuery

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Overrides

Widget.idPrefix

Defined in

src/ui/widgets/propertygrid.ts:13

---

items

• Private items: PropertyItem[]

Defined in

src/ui/widgets/propertygrid.ts:12

---

options

• Protected options: PropertyGridOptions

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:62

---

uniqueName

• Protected uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

widgetName

• Protected widgetName: string

Inherited from

Widget.widgetName

Defined in

src/ui/widgets/widget.ts:63

Accessors

value

• get value(): any

Returns

any

Defined in

src/ui/widgets/propertygrid.ts:570

• set value(val): void

Parameters

Name	Type
val	any

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:574

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

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

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

canModifyItem

▸ Private canModifyItem(item): boolean

Parameters

Name	Type
item	PropertyItem

Returns

boolean

Defined in

src/ui/widgets/propertygrid.ts:580

---

categoryLinkClick

▸ Private categoryLinkClick(e): void

Parameters

Name	Type
e	JQueryEventObject

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:198

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

createCategoryDiv

▸ Private createCategoryDiv(categoriesDiv, categoryIndexes, category, collapsed): JQuery

Parameters

Name	Type
categoriesDiv	JQuery
categoryIndexes	Object
category	string
collapsed	boolean

Returns

JQuery

Defined in

src/ui/widgets/propertygrid.ts:167

---

createCategoryLinks

▸ Private createCategoryLinks(container, items): Record<string, number>

Parameters

Name	Type
container	JQuery
items	PropertyItem[]

Returns

Record<string, number>

Defined in

src/ui/widgets/propertygrid.ts:413

---

createField

▸ Private createField(container, item): any

Parameters

Name	Type
container	JQuery
item	PropertyItem

Returns

any

Defined in

src/ui/widgets/propertygrid.ts:255

---

createItems

▸ Private createItems(container, items): void

Parameters

Name	Type
container	JQuery
items	PropertyItem[]

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:113

---

destroy

▸ destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/widgets/propertygrid.ts:100

---

determineText

▸ Private determineText(text, getKey): string

Parameters

Name	Type
text	string
getKey	(s: string) => string

Returns

string

Defined in

src/ui/widgets/propertygrid.ts:233

---

enumerateItems

▸ enumerateItems(callback): void

Parameters

Name	Type
callback	(p1: PropertyItem, p2: Widget<any>) => void

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:628

---

getCategoryOrder

▸ Private getCategoryOrder(items): any

Parameters

Name	Type
items	PropertyItem[]

Returns

any

Defined in

src/ui/widgets/propertygrid.ts:382

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

get_editors

▸ get_editors(): Widget<any>[]

Returns

Widget<any>[]

Defined in

src/ui/widgets/propertygrid.ts:483

---

get_idPrefix

▸ get_idPrefix(): string

Returns

string

Defined in

src/ui/widgets/propertygrid.ts:491

---

get_items

▸ get_items(): PropertyItem[]

Returns

PropertyItem[]

Defined in

src/ui/widgets/propertygrid.ts:487

---

get_mode

▸ get_mode(): PropertyGridMode

Returns

PropertyGridMode

Defined in

src/ui/widgets/propertygrid.ts:495

---

init

▸ init(action?): PropertyGrid

Parameters

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

Returns

PropertyGrid

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:179

---

initialize

▸ initialize(): void

Returns

void

Inherited from

Widget.initialize

Defined in

src/ui/widgets/widget.ts:176

---

load

▸ load(source): void

Parameters

Name	Type
source	any

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:544

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

save

▸ save(target?): any

Parameters

Name	Type
target?	any

Returns

any

Defined in

src/ui/widgets/propertygrid.ts:557

---

set_mode

▸ set_mode(value): void

Parameters

Name	Type
value	PropertyGridMode

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:499

---

updateInterface

▸ updateInterface(): void

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:606

---

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

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

Widget.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:124

---

loadEditorValue

▸ Static loadEditorValue(editor, item, source): void

Parameters

Name	Type
editor	Widget<any>
item	PropertyItem
source	any

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:507

---

saveEditorValue

▸ Static saveEditorValue(editor, item, target): void

Parameters

Name	Type
editor	Widget<any>
item	PropertyItem
target	any

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:512

---

setMaxLength

▸ Static Private setMaxLength(widget, maxLength): void

Parameters

Name	Type
widget	Widget<any>
maxLength	number

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:533

---

setReadOnly

▸ Static Private setReadOnly(widget, isReadOnly): void

Parameters

Name	Type
widget	Widget<any>
isReadOnly	boolean

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:519

---

setReadonly

▸ Static Private setReadonly(elements, isReadOnly): JQuery

Parameters

Name	Type
elements	JQuery
isReadOnly	boolean

Returns

JQuery

Defined in

src/ui/widgets/propertygrid.ts:524

---

setRequired

▸ Static Private setRequired(widget, isRequired): void

Parameters

Name	Type
widget	Widget<any>
isRequired	boolean

Returns

void

Defined in

src/ui/widgets/propertygrid.ts:529