@serenity-is/corelib / PropertyPanel
Class: PropertyPanel<TItem, P>
Type parameters
Name |
---|
TItem |
P |
Hierarchy
-
↳
PropertyPanel
Table of contents
Constructors
Properties
Accessors
Methods
- addCssClass
- addValidationRule
- arrange
- byId
- change
- changeSelect2
- destroy
- findById
- getCssClass
- getCustomAttribute
- getFieldElement
- getFormKey
- getGridField
- getPropertyGridOptions
- getPropertyItems
- getSaveEntity
- getTemplate
- getToolbarButtons
- getValidatorOptions
- get_entity
- get_entityId
- init
- initPropertyGrid
- initTabs
- initToolbar
- initValidator
- internalInit
- internalRenderContents
- loadInitialEntity
- render
- renderContents
- resetValidation
- set_entity
- set_entityId
- syncOrAsyncThen
- useIdPrefix
- validateBeforeSave
- validateForm
- create
- createDefaultElement
- getWidgetName
Constructors
constructor
• new PropertyPanel<TItem
, P
>(props
): PropertyPanel
<TItem
, P
>
Type parameters
Name |
---|
TItem |
P |
Parameters
Name | Type |
---|---|
props |
WidgetProps <P > |
Returns
PropertyPanel
<TItem
, P
>
Overrides
Defined in
src/ui/widgets/propertypanel.ts:15
Properties
domNode
• Readonly
domNode: HTMLElement
Inherited from
Defined in
idPrefix
• Readonly
idPrefix: string
Inherited from
Defined in
isPanel
• Protected
isPanel: boolean
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:42
options
• Protected
Readonly
options: WidgetProps
<P
>
Inherited from
Defined in
propertyGrid
• Protected
propertyGrid: PropertyGrid
<PropertyGridOptions
>
Defined in
src/ui/widgets/propertypanel.ts:107
responsive
• Protected
responsive: boolean
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:43
tabs
• Protected
tabs: Fluent
<HTMLElement
>
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:39
toolbar
• Protected
toolbar: Toolbar
<ToolbarOptions
>
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:40
uniqueName
• Protected
Readonly
uniqueName: string
Inherited from
Defined in
validator
• Protected
validator: Validator
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:41
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
TemplatedPanel.element
Defined in
props
• get
props(): WidgetProps
<P
>
Returns
WidgetProps
<P
>
Inherited from
TemplatedPanel.props
Defined in
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
TemplatedPanel.addValidationRule
Defined in
▸ addValidationRule(uniqueName
, rule
): void
Parameters
Name | Type |
---|---|
uniqueName |
string |
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
Returns
void
Inherited from
TemplatedPanel.addValidationRule
Defined in
arrange
▸ arrange(): void
Returns
void
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:45
byId
▸ byId<TElement
>(id
): Fluent
<TElement
>
Type parameters
Name | Type |
---|---|
TElement |
extends HTMLElement = HTMLElement |
Parameters
Name | Type |
---|---|
id |
string |
Returns
Fluent
<TElement
>
Inherited from
Defined in
src/ui/widgets/templatedwidget.ts:8
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/propertypanel.ts:22
findById
▸ findById<TElement
>(id
): TElement
Type parameters
Name | Type |
---|---|
TElement |
extends HTMLElement = HTMLElement |
Parameters
Name | Type |
---|---|
id |
string |
Returns
TElement
Inherited from
Defined in
src/ui/widgets/templatedwidget.ts:12
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
TemplatedPanel.getCustomAttribute
Defined in
getFieldElement
▸ getFieldElement(): HTMLElement
Returns
HTMLElement
Inherited from
TemplatedPanel.getFieldElement
Defined in
getFormKey
▸ getFormKey(): string
Returns
string
Defined in
src/ui/widgets/propertypanel.ts:48
getGridField
▸ getGridField(): Fluent
<HTMLElement
>
Returns
Fluent
<HTMLElement
>
Inherited from
Defined in
getPropertyGridOptions
▸ getPropertyGridOptions(): PropertyGridOptions
Returns
Defined in
src/ui/widgets/propertypanel.ts:64
getPropertyItems
▸ getPropertyItems(): PropertyItem
[]
Returns
Defined in
src/ui/widgets/propertypanel.ts:74
getSaveEntity
▸ getSaveEntity(): TItem
Returns
TItem
Defined in
src/ui/widgets/propertypanel.ts:79
getTemplate
▸ getTemplate(): string
Returns
string
Inherited from
Defined in
src/ui/widgets/templatedwidget.ts:16
getToolbarButtons
▸ getToolbarButtons(): ToolButton
[]
Returns
Inherited from
TemplatedPanel.getToolbarButtons
Defined in
src/ui/widgets/templatedpanel.ts:51
getValidatorOptions
▸ getValidatorOptions(): any
Returns
any
Inherited from
TemplatedPanel.getValidatorOptions
Defined in
src/ui/widgets/templatedpanel.ts:55
get_entity
▸ get_entity(): TItem
Returns
TItem
Defined in
src/ui/widgets/propertypanel.ts:87
get_entityId
▸ get_entityId(): any
Returns
any
Defined in
src/ui/widgets/propertypanel.ts:91
init
▸ init(): this
Returns
this
Inherited from
Defined in
initPropertyGrid
▸ initPropertyGrid(): void
Returns
void
Defined in
src/ui/widgets/propertypanel.ts:34
initTabs
▸ initTabs(): void
Returns
void
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:59
initToolbar
▸ initToolbar(): void
Returns
void
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:66
initValidator
▸ initValidator(): void
Returns
void
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:73
internalInit
▸ internalInit(): void
Returns
void
Inherited from
Defined in
internalRenderContents
▸ internalRenderContents(): void
Returns
void
Inherited from
TemplatedPanel.internalRenderContents
Defined in
loadInitialEntity
▸ 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
Defined in
renderContents
▸ renderContents(): void
Returns
void
Inherited from
Defined in
src/ui/widgets/templatedwidget.ts:20
resetValidation
▸ resetValidation(): void
Returns
void
Inherited from
TemplatedPanel.resetValidation
Defined in
src/ui/widgets/templatedpanel.ts:81
set_entity
▸ set_entity(value
): void
Parameters
Name | Type |
---|---|
value |
TItem |
Returns
void
Defined in
src/ui/widgets/propertypanel.ts:95
set_entityId
▸ set_entityId(value
): void
Parameters
Name | Type |
---|---|
value |
any |
Returns
void
Defined in
src/ui/widgets/propertypanel.ts:99
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
TemplatedPanel.syncOrAsyncThen
Defined in
useIdPrefix
▸ useIdPrefix(): IdPrefixType
Returns
Inherited from
Defined in
validateBeforeSave
▸ validateBeforeSave(): boolean
Returns
boolean
Defined in
src/ui/widgets/propertypanel.ts:103
validateForm
▸ validateForm(): boolean
Returns
boolean
Inherited from
Defined in
src/ui/widgets/templatedpanel.ts:87
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
TemplatedPanel.createDefaultElement
Defined in
getWidgetName
▸ getWidgetName(type
): string
Parameters
Name | Type |
---|---|
type |
Function |
Returns
string