@serenity-is/corelib / PropertyGrid
Class: PropertyGrid<P>
Type parameters
Name | Type |
---|---|
P |
extends PropertyGridOptions = PropertyGridOptions |
Hierarchy
Widget
<P
>↳
PropertyGrid
Table of contents
Constructors
Properties
Accessors
Methods
- addCssClass
- addValidationRule
- change
- changeSelect2
- destroy
- enumerateItems
- getCssClass
- getCustomAttribute
- getFieldElement
- getGridField
- get_editors
- get_idPrefix
- get_items
- get_mode
- init
- internalInit
- internalRenderContents
- load
- render
- renderContents
- save
- set_mode
- syncOrAsyncThen
- updateInterface
- useIdPrefix
- create
- createDefaultElement
- getWidgetName
Constructors
constructor
• new PropertyGrid<P
>(props
): PropertyGrid
<P
>
Type parameters
Name | Type |
---|---|
P |
extends PropertyGridOptions = PropertyGridOptions |
Parameters
Name | Type |
---|---|
props |
WidgetProps <P > |
Returns
PropertyGrid
<P
>
Inherited from
Defined in
Properties
domNode
• Readonly
domNode: HTMLElement
Inherited from
Defined in
idPrefix
• Readonly
idPrefix: string
Inherited from
Defined in
options
• Protected
Readonly
options: WidgetProps
<P
>
Inherited from
Defined in
uniqueName
• Protected
Readonly
uniqueName: string
Inherited from
Defined in
typeInfo
▪ Static
typeInfo: ClassTypeInfo
<"Serenity.Widget"
>
Inherited from
Defined in
Accessors
element
• get
element(): Fluent
<HTMLElement
>
Returns a Fluent(this.domNode) object
Returns
Fluent
<HTMLElement
>
Inherited from
Widget.element
Defined in
props
• get
props(): WidgetProps
<P
>
Returns
WidgetProps
<P
>
Inherited from
Widget.props
Defined in
value
• get
value(): any
Returns
any
Defined in
src/ui/widgets/propertygrid.ts:508
• set
value(val
): void
Parameters
Name | Type |
---|---|
val |
any |
Returns
void
Defined in
src/ui/widgets/propertygrid.ts:512
Methods
addCssClass
▸ addCssClass(): void
Returns
void
Inherited from
Defined in
addValidationRule
▸ addValidationRule(rule
, uniqueName?
): void
Parameters
Name | Type |
---|---|
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
uniqueName? |
string |
Returns
void
Inherited from
Defined in
▸ addValidationRule(uniqueName
, rule
): void
Parameters
Name | Type |
---|---|
uniqueName |
string |
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
Returns
void
Inherited from
Defined in
change
▸ change(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Inherited from
Defined in
changeSelect2
▸ changeSelect2(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Inherited from
Defined in
destroy
▸ destroy(): void
Returns
void
Overrides
Defined in
src/ui/widgets/propertygrid.ts:82
enumerateItems
▸ enumerateItems(callback
): void
Parameters
Name | Type |
---|---|
callback |
(p1 : PropertyItem , p2 : Widget <any >) => void |
Returns
void
Defined in
src/ui/widgets/propertygrid.ts:566
getCssClass
▸ getCssClass(): string
Returns
string
Inherited from
Defined in
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
Defined in
getFieldElement
▸ getFieldElement(): HTMLElement
Returns
HTMLElement
Inherited from
Defined in
getGridField
▸ getGridField(): Fluent
<HTMLElement
>
Returns
Fluent
<HTMLElement
>
Inherited from
Defined in
get_editors
▸ get_editors(): Widget
<any
>[]
Returns
Widget
<any
>[]
Defined in
src/ui/widgets/propertygrid.ts:448
get_idPrefix
▸ get_idPrefix(): string
Returns
string
Defined in
src/ui/widgets/propertygrid.ts:456
get_items
▸ get_items(): PropertyItem
[]
Returns
Defined in
src/ui/widgets/propertygrid.ts:452
get_mode
▸ get_mode(): PropertyGridMode
Returns
Defined in
src/ui/widgets/propertygrid.ts:460
init
▸ init(): this
Returns
this
Inherited from
Defined in
internalInit
▸ internalInit(): void
Returns
void
Inherited from
Defined in
internalRenderContents
▸ internalRenderContents(): void
Returns
void
Inherited from
Defined in
load
▸ load(source
): void
Parameters
Name | Type |
---|---|
source |
any |
Returns
void
Defined in
src/ui/widgets/propertygrid.ts:482
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
Defined in
renderContents
▸ renderContents(): void
Returns
void
Overrides
Defined in
src/ui/widgets/propertygrid.ts:16
save
▸ save(target?
): any
Parameters
Name | Type |
---|---|
target? |
any |
Returns
any
Defined in
src/ui/widgets/propertygrid.ts:495
set_mode
▸ set_mode(value
): void
Parameters
Name | Type |
---|---|
value |
PropertyGridMode |
Returns
void
Defined in
src/ui/widgets/propertygrid.ts:464
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
Defined in
updateInterface
▸ updateInterface(): void
Returns
void
Defined in
src/ui/widgets/propertygrid.ts:544
useIdPrefix
▸ useIdPrefix(): IdPrefixType
Returns
Inherited from
Defined in
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
Defined in
createDefaultElement
▸ createDefaultElement(): HTMLElement
Returns
HTMLElement
Inherited from
Defined in
getWidgetName
▸ getWidgetName(type
): string
Parameters
Name | Type |
---|---|
type |
Function |
Returns
string