@serenity-is/corelib / HtmlContentEditor

Class: HtmlContentEditor<P>

Type parameters

Name	Type
P	extends HtmlContentEditorOptions = HtmlContentEditorOptions

Hierarchy

• EditorWidget<P>

  ↳ HtmlContentEditor

  ↳↳ HtmlNoteContentEditor

  ↳↳ HtmlReportContentEditor

Implements

• IStringValue
• IReadOnly

Table of contents

Constructors

• constructor

Properties

• domNode
• idPrefix
• options
• uniqueName
• CKEditorBasePath
• CKEditorVer
• typeInfo

Accessors

• element
• props
• value

Methods

• addCssClass
• addValidationRule
• change
• changeSelect2
• destroy
• getConfig
• getCssClass
• getCustomAttribute
• getEditorInstance
• getFieldElement
• getGridField
• getLanguage
• get_readOnly
• get_value
• init
• instanceReady
• internalInit
• internalRenderContents
• render
• renderContents
• set_readOnly
• set_value
• syncOrAsyncThen
• useIdPrefix
• create
• createDefaultElement
• getCKEditorBasePath
• getWidgetName
• includeCKEditor

Constructors

constructor

• new HtmlContentEditor<P>(props): HtmlContentEditor<P>

Type parameters

Name	Type
P	extends HtmlContentEditorOptions = HtmlContentEditorOptions

Parameters

Name	Type
props	EditorProps<P>

Returns

HtmlContentEditor<P>

Overrides

EditorWidget.constructor

Defined in

src/ui/editors/htmlcontenteditor.ts:25

Properties

domNode

• Readonly domNode: HTMLTextAreaElement

Overrides

EditorWidget.domNode

Defined in

src/ui/editors/htmlcontenteditor.ts:21

---

idPrefix

• Readonly idPrefix: string

Inherited from

EditorWidget.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

options

• Protected Readonly options: WidgetProps<EditorProps<P>>

Inherited from

EditorWidget.options

Defined in

src/ui/widgets/widget.ts:15

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

EditorWidget.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

CKEditorBasePath

▪ Static CKEditorBasePath: string

Defined in

src/ui/editors/htmlcontenteditor.ts:198

---

CKEditorVer

▪ Static CKEditorVer: string = "4.22.1"

Defined in

src/ui/editors/htmlcontenteditor.ts:197

---

typeInfo

▪ Static typeInfo: ClassTypeInfo<"Serenity.EditorWidget">

Inherited from

EditorWidget.typeInfo

Defined in

src/ui/widgets/widget.ts:202

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

EditorWidget.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

EditorWidget.props

Defined in

src/ui/widgets/widget.ts:182

---

value

• get value(): string

Returns

string

Defined in

src/ui/editors/htmlcontenteditor.ts:162

• set value(v): void

Parameters

Name	Type
v	string

Returns

void

Defined in

src/ui/editors/htmlcontenteditor.ts:173

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

EditorWidget.addCssClass

Defined in

src/ui/widgets/widget.ts:71

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

Name	Type
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string
uniqueName?	string

Returns

void

Inherited from

EditorWidget.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

▸ addValidationRule(uniqueName, rule): void

Parameters

Name	Type
uniqueName	string
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string

Returns

void

Inherited from

EditorWidget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

EditorWidget.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

EditorWidget.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

destroy

▸ destroy(): void

Returns

void

Overrides

EditorWidget.destroy

Defined in

src/ui/editors/htmlcontenteditor.ts:146

---

getConfig

▸ getConfig(): CKEditorConfig

Returns

CKEditorConfig

Defined in

src/ui/editors/htmlcontenteditor.ts:91

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

EditorWidget.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

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

EditorWidget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getEditorInstance

▸ getEditorInstance(): any

Returns

any

Defined in

src/ui/editors/htmlcontenteditor.ts:141

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

EditorWidget.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

EditorWidget.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getLanguage

▸ getLanguage(): string

Returns

string

Defined in

src/ui/editors/htmlcontenteditor.ts:72

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/editors/htmlcontenteditor.ts:177

---

get_value

▸ get_value(): string

Returns

string

Implementation of

IStringValue.get_value

Defined in

src/ui/editors/htmlcontenteditor.ts:152

---

init

▸ init(): this

Returns

this

Inherited from

EditorWidget.init

Defined in

src/ui/widgets/widget.ts:146

---

instanceReady

▸ instanceReady(x): void

Parameters

Name	Type
x	any

Returns

void

Defined in

src/ui/editors/htmlcontenteditor.ts:60

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

EditorWidget.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

EditorWidget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

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

EditorWidget.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): any

Returns

any

Inherited from

EditorWidget.renderContents

Defined in

src/ui/widgets/widget.ts:178

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/editors/htmlcontenteditor.ts:181

---

set_value

▸ set_value(value): void

Parameters

Name	Type
value	string

Returns

void

Implementation of

IStringValue.set_value

Defined in

src/ui/editors/htmlcontenteditor.ts:166

---

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

EditorWidget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

EditorWidget.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

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

EditorWidget.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLTextAreaElement

Returns

HTMLTextAreaElement

Overrides

EditorWidget.createDefaultElement

Defined in

src/ui/editors/htmlcontenteditor.ts:23

---

getCKEditorBasePath

▸ getCKEditorBasePath(): string

Returns

string

Defined in

src/ui/editors/htmlcontenteditor.ts:200

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

EditorWidget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95

---

includeCKEditor

▸ includeCKEditor(then): void

Parameters

Name	Type
then	() => void

Returns

void

Defined in

src/ui/editors/htmlcontenteditor.ts:215