@serenity-is/corelib / HtmlContentEditor

Class: HtmlContentEditor

Hierarchy

• Widget<HtmlContentEditorOptions>

  ↳ HtmlContentEditor

  ↳↳ HtmlNoteContentEditor

  ↳↳ HtmlReportContentEditor

Implements

• IStringValue
• IReadOnly

Table of contents

Constructors

• constructor

Properties

• _instanceReady
• element
• idPrefix
• options
• uniqueName
• widgetName
• CKEditorBasePath
• CKEditorVer

Accessors

• value

Methods

• addCssClass
• addValidationRule
• change
• changeSelect2
• destroy
• getConfig
• getCssClass
• getEditorInstance
• getGridField
• getLanguage
• get_readOnly
• get_value
• init
• initialize
• instanceReady
• renderContents
• set_readOnly
• set_value
• create
• elementFor
• getCKEditorBasePath
• getWidgetName
• includeCKEditor

Constructors

constructor

• new HtmlContentEditor(textArea, opt?)

Parameters

Name	Type
textArea	JQuery
opt?	HtmlContentEditorOptions

Overrides

Widget.constructor

Defined in

src/ui/editors/htmlcontenteditor.ts:22

Properties

_instanceReady

• Private _instanceReady: boolean

Defined in

src/ui/editors/htmlcontenteditor.ts:20

---

element

• element: JQuery

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

options

• Protected options: HtmlContentEditorOptions

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

---

CKEditorBasePath

▪ Static CKEditorBasePath: string

Defined in

src/ui/editors/htmlcontenteditor.ts:191

---

CKEditorVer

▪ Static CKEditorVer: string = "4.7.1"

Defined in

src/ui/editors/htmlcontenteditor.ts:190

Accessors

value

• get value(): string

Returns

string

Defined in

src/ui/editors/htmlcontenteditor.ts:155

• set value(v): void

Parameters

Name	Type
v	string

Returns

void

Defined in

src/ui/editors/htmlcontenteditor.ts:166

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

---

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

---

destroy

▸ destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/editors/htmlcontenteditor.ts:139

---

getConfig

▸ Protected getConfig(): CKEditorConfig

Returns

CKEditorConfig

Defined in

src/ui/editors/htmlcontenteditor.ts:85

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getEditorInstance

▸ Protected getEditorInstance(): any

Returns

any

Defined in

src/ui/editors/htmlcontenteditor.ts:134

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getLanguage

▸ Protected getLanguage(): string

Returns

string

Defined in

src/ui/editors/htmlcontenteditor.ts:66

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/editors/htmlcontenteditor.ts:170

---

get_value

▸ get_value(): string

Returns

string

Implementation of

IStringValue.get_value

Defined in

src/ui/editors/htmlcontenteditor.ts:145

---

init

▸ init(action?): HtmlContentEditor

Parameters

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

Returns

HtmlContentEditor

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

---

instanceReady

▸ Protected instanceReady(x): void

Parameters

Name	Type
x	any

Returns

void

Defined in

src/ui/editors/htmlcontenteditor.ts:56

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

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:174

---

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:159

---

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

---

getCKEditorBasePath

▸ Static getCKEditorBasePath(): string

Returns

string

Defined in

src/ui/editors/htmlcontenteditor.ts:193

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:124

---

includeCKEditor

▸ Static includeCKEditor(): void

Returns

void

Defined in

src/ui/editors/htmlcontenteditor.ts:208