@serenity-is/corelib / TimeSpanEditor

Class: TimeSpanEditor<P>

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

Extends

• TimeEditorBase<P>

Type Parameters

• P extends TimeSpanEditorOptions = TimeSpanEditorOptions

Constructors

new TimeSpanEditor()

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

Parameters

props

EditorProps<P>

Returns

TimeSpanEditor<P>

Overrides

TimeEditorBase.constructor

Defined in

src/ui/editors/timeeditor.ts:158

Properties

domNode

readonly domNode: HTMLSelectElement

Inherited from

TimeEditorBase.domNode

Defined in

src/ui/editors/timeeditor.ts:17

---

idPrefix

readonly idPrefix: string

Inherited from

TimeEditorBase.idPrefix

Defined in

src/ui/widgets/widget.ts:16

---

minutes

protected minutes: Fluent<HTMLElement>

Inherited from

TimeEditorBase.minutes

Defined in

src/ui/editors/timeeditor.ts:19

---

options

protected readonly options: WidgetProps<EditorProps<P>>

Inherited from

TimeEditorBase.options

Defined in

src/ui/widgets/widget.ts:14

---

uniqueName

readonly uniqueName: string

Inherited from

TimeEditorBase.uniqueName

Defined in

src/ui/widgets/widget.ts:15

---

isComponent

readonly static isComponent: true = true

Inherited from

TimeEditorBase.isComponent

Defined in

src/ui/widgets/widget.ts:223

---

typeInfo

static typeInfo: ClassTypeInfo<"Serenity.EditorWidget">

Inherited from

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

TimeEditorBase.element

Defined in

src/ui/widgets/widget.ts:63

---

hour

Get Signature

get hour(): number

Returns

number

Inherited from

TimeEditorBase.hour

Defined in

src/ui/editors/timeeditor.ts:45

---

hourAndMin

Get Signature

get hourAndMin(): string

Returns value in HH:mm format

Returns

string

Set Signature

set hourAndMin(value): void

Sets value in HH:mm format

Parameters

value

string

Returns

void

Inherited from

TimeEditorBase.hourAndMin

Defined in

src/ui/editors/timeeditor.ts:64

---

minute

Get Signature

get minute(): number

Returns

number

Inherited from

TimeEditorBase.minute

Defined in

src/ui/editors/timeeditor.ts:49

---

props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

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

TimeEditorBase.readOnly

Defined in

src/ui/editors/editorwidget.ts:23

---

value

Get Signature

get value(): string

Returns

string

Set Signature

set value(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/timeeditor.ts:172

Methods

addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

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

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

TimeEditorBase.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

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

TimeEditorBase.byId

Defined in

src/ui/widgets/widget.ts:106

---

change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

TimeEditorBase.change

Defined in

src/ui/widgets/widget.ts:118

---

changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

TimeEditorBase.changeSelect2

Defined in

src/ui/widgets/widget.ts:122

---

deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

TimeEditorBase.deferRender

Defined in

src/ui/widgets/widget.ts:71

---

destroy()

destroy(): void

Returns

void

Inherited from

TimeEditorBase.destroy

Defined in

src/ui/widgets/widget.ts:47

---

findById()

protected findById<TElement>(id): TElement

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

TimeEditorBase.findById

Defined in

src/ui/widgets/widget.ts:110

---

get_readOnly()

get_readOnly(): boolean

Returns

boolean

Inherited from

TimeEditorBase.get_readOnly

Defined in

src/ui/editors/timeeditor.ts:53

---

get_value()

protected get_value(): string

Returns

string

Defined in

src/ui/editors/timeeditor.ts:164

---

getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

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

TimeEditorBase.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142

---

getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

TimeEditorBase.getGridField

Defined in

src/ui/widgets/widget.ts:114

---

init()

init(): this

Returns

this

Inherited from

TimeEditorBase.init

Defined in

src/ui/widgets/widget.ts:157

---

internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

TimeEditorBase.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

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

TimeEditorBase.render

Defined in

src/ui/widgets/widget.ts:167

---

renderContents()

protected renderContents(): any

Returns

any

Inherited from

TimeEditorBase.renderContents

Defined in

src/ui/widgets/widget.ts:188

---

set_readOnly()

set_readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

TimeEditorBase.set_readOnly

Defined in

src/ui/editors/timeeditor.ts:57

---

set_value()

protected set_value(value): void

Parameters

value

string

Returns

void

Defined in

src/ui/editors/timeeditor.ts:168

---

syncOrAsyncThen()

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

Type Parameters

• T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

TimeEditorBase.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

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

TimeEditorBase.create

Defined in

src/ui/widgets/widget.ts:130

---

createDefaultElement()

static createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

TimeEditorBase.createDefaultElement

Defined in

src/ui/editors/timeeditor.ts:16

---

getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

TimeEditorBase.getWidgetName

Defined in

src/ui/widgets/widget.ts:95