Previous Page Next Page

@serenity-is/corelib / EmailAddressEditor

Class: EmailAddressEditor<P>

Type parameters

Name Type
P

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Type parameters

Name Type
P

Parameters

Name Type
props EditorProps<P>

Returns

EmailAddressEditor<P>

Overrides

StringEditor.constructor

Defined in

src/ui/editors/emailaddresseditor.ts:11

Properties

domNode

• Readonly domNode: HTMLInputElement

Inherited from

StringEditor.domNode

Defined in

src/ui/editors/stringeditor.ts:10

idPrefix

• Readonly idPrefix: string

Inherited from

StringEditor.idPrefix

Defined in

src/ui/widgets/widget.ts:17

options

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

Inherited from

StringEditor.options

Defined in

src/ui/widgets/widget.ts:15

uniqueName

• Protected Readonly uniqueName: string

Inherited from

StringEditor.uniqueName

Defined in

src/ui/widgets/widget.ts:16

typeInfo

▪ Static typeInfo: EditorTypeInfo<"Serenity.StringEditor">

Inherited from

StringEditor.typeInfo

Defined in

src/ui/editors/stringeditor.ts:8

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

StringEditor.element

Defined in

src/ui/widgets/widget.ts:67

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

StringEditor.props

Defined in

src/ui/widgets/widget.ts:182

value

• get value(): string

Returns

string

Inherited from

StringEditor.value

Defined in

src/ui/editors/stringeditor.ts:14

• set value(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

StringEditor.value

Defined in

src/ui/editors/stringeditor.ts:22

Methods

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

StringEditor.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

StringEditor.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

StringEditor.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

change

▸ change(handler): void

Parameters

Name Type
handler (e: Event) => void

Returns

void

Inherited from

StringEditor.change

Defined in

src/ui/widgets/widget.ts:114

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name Type
handler (e: Event) => void

Returns

void

Inherited from

StringEditor.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

destroy

▸ destroy(): void

Returns

void

Inherited from

StringEditor.destroy

Defined in

src/ui/widgets/widget.ts:49

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

StringEditor.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

StringEditor.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

StringEditor.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

StringEditor.getGridField

Defined in

src/ui/widgets/widget.ts:110

get_value

▸ get_value(): string

Returns

string

Inherited from

StringEditor.get_value

Defined in

src/ui/editors/stringeditor.ts:18

init

▸ init(): this

Returns

this

Inherited from

StringEditor.init

Defined in

src/ui/widgets/widget.ts:146

internalInit

▸ internalInit(): void

Returns

void

Inherited from

StringEditor.internalInit

Defined in

src/ui/widgets/widget.ts:142

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

StringEditor.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

StringEditor.render

Defined in

src/ui/widgets/widget.ts:159

renderContents

▸ renderContents(): any

Returns

any

Inherited from

StringEditor.renderContents

Defined in

src/ui/widgets/widget.ts:178

set_value

▸ set_value(value): void

Parameters

Name Type
value string

Returns

void

Inherited from

StringEditor.set_value

Defined in

src/ui/editors/stringeditor.ts:26

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

StringEditor.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

StringEditor.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

StringEditor.create

Defined in

src/ui/widgets/widget.ts:126

createDefaultElement

▸ createDefaultElement(): HTMLInputElement

Returns

HTMLInputElement

Overrides

StringEditor.createDefaultElement

Defined in

src/ui/editors/emailaddresseditor.ts:9

getWidgetName

▸ getWidgetName(type): string

Parameters

Name Type
type Function

Returns

string

Inherited from

StringEditor.getWidgetName

Defined in

src/ui/widgets/widget.ts:95