Previous Page Next Page

@serenity-is/corelib / HtmlContentEditor

Class: HtmlContentEditor<P>

Defined in: src/ui/editors/htmlcontenteditor.tsx:15

Extends

Extended by

Type Parameters

P

P extends HtmlContentEditorOptions = HtmlContentEditorOptions

Implements

Constructors

Constructor

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

Defined in: src/ui/editors/htmlcontenteditor.tsx:24

Parameters

props

EditorProps<P>

Returns

HtmlContentEditor<P>

Overrides

EditorWidget.constructor

Properties

domNode

readonly domNode: HTMLTextAreaElement

Defined in: src/ui/editors/htmlcontenteditor.tsx:20

Overrides

EditorWidget.domNode

idPrefix

readonly idPrefix: string

Defined in: src/ui/widgets/widget.ts:13

Inherited from

EditorWidget.idPrefix

options

protected readonly options: WidgetProps<EditorProps<P>>

Defined in: src/ui/widgets/widget.ts:11

Inherited from

EditorWidget.options

uniqueName

readonly uniqueName: string

Defined in: src/ui/widgets/widget.ts:12

Inherited from

EditorWidget.uniqueName

[typeInfo]

static [typeInfo]: EditorTypeInfo<"Serenity.">

Defined in: src/ui/editors/htmlcontenteditor.tsx:17

Implementation of

IReadOnly.[typeInfo]

Overrides

EditorWidget.[typeInfo]

CKEditorBasePath

static CKEditorBasePath: string

Defined in: src/ui/editors/htmlcontenteditor.tsx:211

CKEditorVer

static CKEditorVer: string = "4.22.1"

Defined in: src/ui/editors/htmlcontenteditor.tsx:210

isComponent

readonly static isComponent: true = true

Defined in: src/ui/widgets/widget.ts:219

Inherited from

EditorWidget.isComponent

Accessors

element

Get Signature

get element(): Fluent

Defined in: src/ui/widgets/widget.ts:59

Returns a Fluent(this.domNode) object

Returns

Fluent

Inherited from

EditorWidget.element

props

Get Signature

get props(): WidgetProps<P>

Defined in: src/ui/widgets/widget.ts:203

Returns

WidgetProps<P>

Inherited from

EditorWidget.props

readOnly

Get Signature

get readOnly(): boolean

Defined in: src/ui/editors/editorwidget.ts:20

Returns

boolean

Set Signature

set readOnly(value): void

Defined in: src/ui/editors/editorwidget.ts:25

Parameters
value

boolean

Returns

void

Inherited from

EditorWidget.readOnly

value

Get Signature

get value(): string

Defined in: src/ui/editors/htmlcontenteditor.tsx:175

Returns

string

Set Signature

set value(v): void

Defined in: src/ui/editors/htmlcontenteditor.tsx:186

Parameters
v

string

Returns

void

Methods

addCssClass()

protected addCssClass(): void

Defined in: src/ui/widgets/widget.ts:63

Returns

void

Inherited from

EditorWidget.addCssClass

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Defined in: src/ui/widgets/widget.ts:95

Parameters
rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

EditorWidget.addValidationRule

Call Signature

addValidationRule(uniqueName, rule): void

Defined in: src/ui/widgets/widget.ts:96

Parameters
uniqueName

string

rule

(input) => string

Returns

void

Inherited from

EditorWidget.addValidationRule

afterRender()

protected afterRender(callback): void

Defined in: src/ui/widgets/widget.ts:142

Parameters

callback

() => void

Returns

void

Inherited from

EditorWidget.afterRender

byId()

protected byId<TElement>(id): Fluent<TElement>

Defined in: src/ui/widgets/widget.ts:102

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

EditorWidget.byId

change()

change(handler): void

Defined in: src/ui/widgets/widget.ts:114

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.change

changeSelect2()

changeSelect2(handler): void

Defined in: src/ui/widgets/widget.ts:118

Parameters

handler

(e) => void

Returns

void

Inherited from

EditorWidget.changeSelect2

deferRender()

protected deferRender(): boolean

Defined in: src/ui/widgets/widget.ts:67

Returns

boolean

Inherited from

EditorWidget.deferRender

destroy()

destroy(): void

Defined in: src/ui/editors/htmlcontenteditor.tsx:159

Returns

void

Overrides

EditorWidget.destroy

findById()

protected findById<TElement>(id): TElement

Defined in: src/ui/widgets/widget.ts:106

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

EditorWidget.findById

get_readOnly()

get_readOnly(): boolean

Defined in: src/ui/editors/htmlcontenteditor.tsx:190

Returns

boolean

Implementation of

IReadOnly.get_readOnly

get_value()

get_value(): string

Defined in: src/ui/editors/htmlcontenteditor.tsx:165

Returns

string

Implementation of

IStringValue.get_value

getConfig()

protected getConfig(): CKEditorConfig

Defined in: src/ui/editors/htmlcontenteditor.tsx:92

Returns

CKEditorConfig

getCssClass()

protected getCssClass(): string

Defined in: src/ui/widgets/widget.ts:71

Returns

string

Inherited from

EditorWidget.getCssClass

getCustomAttribute()

protected getCustomAttribute<TAttr>(attrType, inherit): TAttr

Defined in: src/ui/widgets/widget.ts:138

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

EditorWidget.getCustomAttribute

getEditorInstance()

protected getEditorInstance(): any

Defined in: src/ui/editors/htmlcontenteditor.tsx:154

Returns

any

getGridField()

getGridField(): Fluent

Defined in: src/ui/widgets/widget.ts:110

Returns

Fluent

Inherited from

EditorWidget.getGridField

getLanguage()

protected getLanguage(): string

Defined in: src/ui/editors/htmlcontenteditor.tsx:71

Returns

string

init()

init(): this

Defined in: src/ui/widgets/widget.ts:153

Returns

this

Inherited from

EditorWidget.init

instanceReady()

protected instanceReady(x): void

Defined in: src/ui/editors/htmlcontenteditor.tsx:59

Parameters

x

any

Returns

void

internalRenderContents()

internalRenderContents(): void

Defined in: src/ui/widgets/widget.ts:173

Returns

void

Inherited from

EditorWidget.internalRenderContents

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Defined in: src/ui/widgets/widget.ts:190

Returns

boolean

Inherited from

EditorWidget.legacyTemplateRender

render()

render(): any

Defined in: src/ui/widgets/widget.ts:163

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

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/widget.ts:184

Returns

any

Inherited from

EditorWidget.renderContents

set_readOnly()

set_readOnly(value): void

Defined in: src/ui/editors/htmlcontenteditor.tsx:194

Parameters

value

boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

set_value()

set_value(value): void

Defined in: src/ui/editors/htmlcontenteditor.tsx:179

Parameters

value

string

Returns

void

Implementation of

IStringValue.set_value

syncOrAsyncThen()

protected syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void

Defined in: src/ui/widgets/widget.ts:207

Type Parameters

T

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

EditorWidget.syncOrAsyncThen

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Defined in: src/ui/widgets/widget.ts:214

Returns

IdPrefixType

Inherited from

EditorWidget.useIdPrefix

create()

static create<TWidget, P>(params): TWidget

Defined in: src/ui/widgets/widget.ts:126

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

EditorWidget.create

createDefaultElement()

static createDefaultElement(): HTMLTextAreaElement

Defined in: src/ui/editors/htmlcontenteditor.tsx:22

Returns

HTMLTextAreaElement

Overrides

EditorWidget.createDefaultElement

getCKEditorBasePath()

static getCKEditorBasePath(): string

Defined in: src/ui/editors/htmlcontenteditor.tsx:213

Returns

string

getWidgetName()

static getWidgetName(type): string

Defined in: src/ui/widgets/widget.ts:91

Parameters

type

Function

Returns

string

Inherited from

EditorWidget.getWidgetName

includeCKEditor()

static includeCKEditor(then): void

Defined in: src/ui/editors/htmlcontenteditor.tsx:226

Parameters

then

() => void

Returns

void

registerClass()

protected static registerClass<TypeName>(typeName, intfAndAttr?): ClassTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:221

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

ClassTypeInfo<TypeName>

Inherited from

EditorWidget.registerClass

registerEditor()

protected static registerEditor<TypeName>(typeName, intfAndAttr?): EditorTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:230

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

EditorTypeInfo<TypeName>

Inherited from

EditorWidget.registerEditor