@serenity-is/corelib / HtmlReportContentEditor

Class: HtmlReportContentEditor<P>

Extends

HtmlContentEditor<P>

Type Parameters

• P extends HtmlContentEditorOptions = HtmlContentEditorOptions

Constructors

new HtmlReportContentEditor()

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

Parameters

Properties

domNode

readonly domNode: HTMLTextAreaElement

Inherited from

HtmlContentEditor.domNode

Defined in

src/ui/editors/htmlcontenteditor.tsx:21

idPrefix

readonly idPrefix: string

Inherited from

HtmlContentEditor.idPrefix

Defined in

src/ui/widgets/widget.ts:16

options

protected readonly options: WidgetProps<EditorProps<P>>

Inherited from

HtmlContentEditor.options

Defined in

src/ui/widgets/widget.ts:14

uniqueName

readonly uniqueName: string

Inherited from

HtmlContentEditor.uniqueName

Defined in

src/ui/widgets/widget.ts:15

CKEditorBasePath

static CKEditorBasePath: string

Inherited from

HtmlContentEditor.CKEditorBasePath

Defined in

src/ui/editors/htmlcontenteditor.tsx:198

CKEditorVer

static CKEditorVer: string = "4.22.1"

Inherited from

HtmlContentEditor.CKEditorVer

Defined in

src/ui/editors/htmlcontenteditor.tsx:197

isComponent

readonly static isComponent: true = true

Inherited from

HtmlContentEditor.isComponent

Defined in

src/ui/widgets/widget.ts:223

typeInfo

static typeInfo: ClassTypeInfo<"Serenity.EditorWidget">

Inherited from

HtmlContentEditor.typeInfo

Defined in

src/ui/editors/editorwidget.ts:17

Accessors

element

Get Signature

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

HtmlContentEditor.element

Defined in

src/ui/widgets/widget.ts:63

props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

HtmlContentEditor.props

Defined in

src/ui/widgets/widget.ts:207

readOnly

Get Signature

get readOnly(): boolean

Returns

boolean

Set Signature

set readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

HtmlContentEditor.readOnly

Defined in

src/ui/editors/editorwidget.ts:23

value

Get Signature

get value(): string

Returns

string

Set Signature

set value(v): void

Parameters

v

string

Returns

void

Inherited from

HtmlContentEditor.value

Defined in

src/ui/editors/htmlcontenteditor.tsx:162

Methods

addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

HtmlContentEditor.addCssClass

Defined in

src/ui/widgets/widget.ts:67

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

HtmlContentEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

Call Signature

addValidationRule(uniqueName, rule): void

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

HtmlContentEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

HtmlContentEditor.afterRender

Defined in

src/ui/widgets/widget.ts:146

byId()

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

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

HtmlContentEditor.byId

Defined in

src/ui/widgets/widget.ts:106

change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

HtmlContentEditor.change

Defined in

src/ui/widgets/widget.ts:118

changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

HtmlContentEditor.changeSelect2

Defined in

src/ui/widgets/widget.ts:122

deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

HtmlContentEditor.deferRender

Defined in

src/ui/widgets/widget.ts:71

destroy()

destroy(): void

Returns

void

Inherited from

HtmlContentEditor.destroy

Defined in

src/ui/editors/htmlcontenteditor.tsx:146

findById()

protected findById<TElement>(id): TElement

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

HtmlContentEditor.findById

Defined in

src/ui/widgets/widget.ts:110

get_readOnly()

get_readOnly(): boolean

Returns

boolean

Inherited from

HtmlContentEditor.get_readOnly

Defined in

src/ui/editors/htmlcontenteditor.tsx:177

get_value()

get_value(): string

Returns

string

Inherited from

HtmlContentEditor.get_value

Defined in

src/ui/editors/htmlcontenteditor.tsx:152

getConfig()

protected getConfig(): CKEditorConfig

Returns

CKEditorConfig

Overrides

HtmlContentEditor.getConfig

Defined in

src/ui/editors/htmlcontenteditor.tsx:252

getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

HtmlContentEditor.getCssClass

Defined in

src/ui/widgets/widget.ts:75

getCustomAttribute()

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

Type Parameters

• TAttr

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

HtmlContentEditor.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142

getEditorInstance()

protected getEditorInstance(): any

Returns

any

Inherited from

HtmlContentEditor.getEditorInstance

Defined in

src/ui/editors/htmlcontenteditor.tsx:141

getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

HtmlContentEditor.getGridField

Defined in

src/ui/widgets/widget.ts:114

getLanguage()

protected getLanguage(): string

Returns

string

Inherited from

HtmlContentEditor.getLanguage

Defined in

src/ui/editors/htmlcontenteditor.tsx:72

init()

init(): this

Returns

this

Inherited from

HtmlContentEditor.init

Defined in

src/ui/widgets/widget.ts:157

instanceReady()

protected instanceReady(x): void

Parameters

x

any

Returns

void

Inherited from

HtmlContentEditor.instanceReady

Defined in

src/ui/editors/htmlcontenteditor.tsx:60

internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

HtmlContentEditor.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

HtmlContentEditor.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194

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

HtmlContentEditor.render

Defined in

src/ui/widgets/widget.ts:167

renderContents()

protected renderContents(): any

Returns

any

Inherited from

HtmlContentEditor.renderContents

Defined in

src/ui/widgets/widget.ts:188

set_readOnly()

set_readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

HtmlContentEditor.set_readOnly

Defined in

src/ui/editors/htmlcontenteditor.tsx:181

set_value()

set_value(value): void

Parameters

value

string

Returns

void

Inherited from

HtmlContentEditor.set_value

Defined in

src/ui/editors/htmlcontenteditor.tsx:166

syncOrAsyncThen()

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

Type Parameters

• T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

HtmlContentEditor.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

HtmlContentEditor.useIdPrefix

Defined in

src/ui/widgets/widget.ts:218

create()

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

Type Parameters

• TWidget extends Widget<P>

• P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

HtmlContentEditor.create

Defined in

src/ui/widgets/widget.ts:130

createDefaultElement()

static createDefaultElement(): HTMLTextAreaElement

Returns

HTMLTextAreaElement

Inherited from

HtmlContentEditor.createDefaultElement

Defined in

src/ui/editors/htmlcontenteditor.tsx:23

getCKEditorBasePath()

static getCKEditorBasePath(): string

Returns

string

Inherited from

HtmlContentEditor.getCKEditorBasePath

Defined in

src/ui/editors/htmlcontenteditor.tsx:200

getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

HtmlContentEditor.getWidgetName

Defined in

src/ui/widgets/widget.ts:95

includeCKEditor()

static includeCKEditor(then): void

Parameters

then

() => void

Returns

void

Inherited from

HtmlContentEditor.includeCKEditor

Defined in

src/ui/editors/htmlcontenteditor.tsx:215