@serenity-is/corelib / TimeSpanEditor

Class: TimeSpanEditor<P>

Defined in: src/ui/editors/timeeditor.ts:155

This editor is for TimeSpan fields. It uses a string value in the format "HH:mm".

Extends

TimeEditorBase<P>

Type Parameters

P

P extends TimeSpanEditorOptions = TimeSpanEditorOptions

Constructors

Constructor

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

Defined in: src/ui/editors/timeeditor.ts:159

Parameters

props

EditorProps<P>

Returns

TimeSpanEditor<P>

Overrides

TimeEditorBase.constructor

Properties

domNode

readonly domNode: HTMLSelectElement

Defined in: src/ui/editors/timeeditor.ts:17

Inherited from

TimeEditorBase.domNode

idPrefix

readonly idPrefix: string

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

Inherited from

TimeEditorBase.idPrefix

minutes

protected minutes: Fluent

Defined in: src/ui/editors/timeeditor.ts:19

Inherited from

TimeEditorBase.minutes

options

protected readonly options: WidgetProps<EditorProps<P>>

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

Inherited from

TimeEditorBase.options

uniqueName

readonly uniqueName: string

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

Inherited from

TimeEditorBase.uniqueName

[typeInfo]

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

Defined in: src/ui/editors/timeeditor.ts:157

Overrides

TimeEditorBase.[typeInfo]

isComponent

readonly static isComponent: true = true

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

Inherited from

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

TimeEditorBase.element

hour

Get Signature

get hour(): number

Defined in: src/ui/editors/timeeditor.ts:45

Returns

number

Inherited from

TimeEditorBase.hour

hourAndMin

Get Signature

get hourAndMin(): string

Defined in: src/ui/editors/timeeditor.ts:64

Returns value in HH:mm format

Returns

string

Set Signature

set hourAndMin(value): void

Defined in: src/ui/editors/timeeditor.ts:74

Sets value in HH:mm format

Parameters

value

string

Returns

void

Inherited from

TimeEditorBase.hourAndMin

minute

Get Signature

get minute(): number

Defined in: src/ui/editors/timeeditor.ts:49

Returns

number

Inherited from

TimeEditorBase.minute

props

Get Signature

get props(): WidgetProps<P>

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

Returns

WidgetProps<P>

Inherited from

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

TimeEditorBase.readOnly

value

Get Signature

get value(): string

Defined in: src/ui/editors/timeeditor.ts:173

Returns

string

Set Signature

set value(value): void

Defined in: src/ui/editors/timeeditor.ts:177

Parameters

value

string

Returns

void

Methods

addCssClass()

protected addCssClass(): void

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

Returns

void

Inherited from

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

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

TimeEditorBase.addValidationRule

afterRender()

protected afterRender(callback): void

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

Parameters

callback

() => void

Returns

void

Inherited from

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

TimeEditorBase.byId

change()

change(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

TimeEditorBase.change

changeSelect2()

changeSelect2(handler): void

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

Parameters

handler

(e) => void

Returns

void

Inherited from

TimeEditorBase.changeSelect2

deferRender()

protected deferRender(): boolean

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

Returns

boolean

Inherited from

TimeEditorBase.deferRender

destroy()

destroy(): void

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

Returns

void

Inherited from

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

TimeEditorBase.findById

get_readOnly()

get_readOnly(): boolean

Defined in: src/ui/editors/timeeditor.ts:53

Returns

boolean

Inherited from

TimeEditorBase.get_readOnly

get_value()

protected get_value(): string

Defined in: src/ui/editors/timeeditor.ts:165

Returns

string

getCssClass()

protected getCssClass(): string

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

Returns

string

Inherited from

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

TimeEditorBase.getCustomAttribute

getGridField()

getGridField(): Fluent

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

Returns

Fluent

Inherited from

TimeEditorBase.getGridField

init()

init(): this

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

Returns

this

Inherited from

TimeEditorBase.init

internalRenderContents()

internalRenderContents(): void

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

Returns

void

Inherited from

TimeEditorBase.internalRenderContents

legacyTemplateRender()

protected legacyTemplateRender(): boolean

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

Returns

boolean

Inherited from

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

TimeEditorBase.render

renderContents()

protected renderContents(): any

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

Returns

any

Inherited from

TimeEditorBase.renderContents

set_readOnly()

set_readOnly(value): void

Defined in: src/ui/editors/timeeditor.ts:57

Parameters

value

boolean

Returns

void

Inherited from

TimeEditorBase.set_readOnly

set_value()

protected set_value(value): void

Defined in: src/ui/editors/timeeditor.ts:169

Parameters

value

string

Returns

void

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

TimeEditorBase.syncOrAsyncThen

useIdPrefix()

protected useIdPrefix(): IdPrefixType

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

Returns

IdPrefixType

Inherited from

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

TimeEditorBase.create

createDefaultElement()

static createDefaultElement(): HTMLElement

Defined in: src/ui/editors/timeeditor.ts:16

Returns

HTMLElement

Inherited from

TimeEditorBase.createDefaultElement

getWidgetName()

static getWidgetName(type): string

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

Parameters

type

Function

Returns

string

Inherited from

TimeEditorBase.getWidgetName

registerClass()

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

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

Type Parameters

TypeName

TypeName

Parameters

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

TimeEditorBase.registerEditor