@serenity-is/corelib / DateTimeEditor

Class: DateTimeEditor

Hierarchy

• Widget<DateTimeEditorOptions>

  ↳ DateTimeEditor

Implements

• IStringValue
• IReadOnly

Table of contents

Constructors

• constructor

Properties

• element
• idPrefix
• lastSetValue
• lastSetValueGet
• maxValue
• minValue
• options
• time
• uniqueName
• widgetName
• getTimeOptions

Accessors

• value
• valueAsDate

Methods

• addCssClass
• addValidationRule
• change
• changeSelect2
• destroy
• getCssClass
• getDisplayFormat
• getFlatpickrOptions
• getGridField
• getInplaceNowText
• get_maxDate
• get_maxValue
• get_minDate
• get_minValue
• get_readOnly
• get_sqlMinMax
• get_value
• get_valueAsDate
• init
• initialize
• renderContents
• set_maxDate
• set_maxValue
• set_minDate
• set_minValue
• set_readOnly
• set_sqlMinMax
• set_value
• set_valueAsDate
• create
• elementFor
• getWidgetName
• roundToMinutes

Constructors

constructor

• new DateTimeEditor(input, opt?)

Parameters

Name	Type
input	JQuery
opt?	DateTimeEditorOptions

Overrides

Widget.constructor

Defined in

src/ui/editors/datetimeeditor.ts:18

Properties

element

• element: JQuery

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:61

---

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

lastSetValue

• Private lastSetValue: string

Defined in

src/ui/editors/datetimeeditor.ts:15

---

lastSetValueGet

• Private lastSetValueGet: string

Defined in

src/ui/editors/datetimeeditor.ts:16

---

maxValue

• Private maxValue: string

Defined in

src/ui/editors/datetimeeditor.ts:13

---

minValue

• Private minValue: string

Defined in

src/ui/editors/datetimeeditor.ts:12

---

options

• Protected options: DateTimeEditorOptions

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:62

---

time

• Private time: JQuery

Defined in

src/ui/editors/datetimeeditor.ts:14

---

uniqueName

• Protected uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

widgetName

• Protected widgetName: string

Inherited from

Widget.widgetName

Defined in

src/ui/widgets/widget.ts:63

---

getTimeOptions

▪ Static getTimeOptions: (fromHour: number, fromMin: number, toHour: number, toMin: number, stepMins: number) => string[]

Type declaration

▸ (fromHour, fromMin, toHour, toMin, stepMins): string[]

Parameters

Name	Type
fromHour	number
fromMin	number
toHour	number
toMin	number
stepMins	number

Returns

string[]

Defined in

src/ui/editors/datetimeeditor.ts:332

Accessors

value

• get value(): string

Returns

string

Defined in

src/ui/editors/datetimeeditor.ts:178

• set value(v): void

Parameters

Name	Type
v	string

Returns

void

Defined in

src/ui/editors/datetimeeditor.ts:222

---

valueAsDate

• get valueAsDate(): Date

Returns

Date

Defined in

src/ui/editors/datetimeeditor.ts:234

• set valueAsDate(value): void

Parameters

Name	Type
value	Date

Returns

void

Defined in

src/ui/editors/datetimeeditor.ts:246

Methods

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:100

---

addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

Name	Type
eventClass	string
rule	(p1: JQuery) => string

Returns

JQuery

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

destroy

▸ destroy(): void

Returns

void

Inherited from

Widget.destroy

Defined in

src/ui/widgets/widget.ts:92

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getDisplayFormat

▸ Private getDisplayFormat(): string

Returns

string

Defined in

src/ui/editors/datetimeeditor.ts:218

---

getFlatpickrOptions

▸ getFlatpickrOptions(): any

Returns

any

Defined in

src/ui/editors/datetimeeditor.ts:137

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getInplaceNowText

▸ Private getInplaceNowText(): string

Returns

string

Defined in

src/ui/editors/datetimeeditor.ts:214

---

get_maxDate

▸ get_maxDate(): Date

Returns

Date

Defined in

src/ui/editors/datetimeeditor.ts:276

---

get_maxValue

▸ get_maxValue(): string

Returns

string

Defined in

src/ui/editors/datetimeeditor.ts:259

---

get_minDate

▸ get_minDate(): Date

Returns

Date

Defined in

src/ui/editors/datetimeeditor.ts:268

---

get_minValue

▸ get_minValue(): string

Returns

string

Defined in

src/ui/editors/datetimeeditor.ts:250

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/editors/datetimeeditor.ts:301

---

get_sqlMinMax

▸ get_sqlMinMax(): boolean

Returns

boolean

Defined in

src/ui/editors/datetimeeditor.ts:285

---

get_value

▸ get_value(): string

Returns

string

Implementation of

IStringValue.get_value

Defined in

src/ui/editors/datetimeeditor.ts:153

---

get_valueAsDate

▸ Private get_valueAsDate(): Date

Returns

Date

Defined in

src/ui/editors/datetimeeditor.ts:226

---

init

▸ init(action?): DateTimeEditor

Parameters

Name	Type
action?	(widget: any) => void

Returns

DateTimeEditor

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:179

---

initialize

▸ initialize(): void

Returns

void

Inherited from

Widget.initialize

Defined in

src/ui/widgets/widget.ts:176

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

set_maxDate

▸ set_maxDate(value): void

Parameters

Name	Type
value	Date

Returns

void

Defined in

src/ui/editors/datetimeeditor.ts:281

---

set_maxValue

▸ set_maxValue(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/datetimeeditor.ts:264

---

set_minDate

▸ set_minDate(value): void

Parameters

Name	Type
value	Date

Returns

void

Defined in

src/ui/editors/datetimeeditor.ts:272

---

set_minValue

▸ set_minValue(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/editors/datetimeeditor.ts:255

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/editors/datetimeeditor.ts:305

---

set_sqlMinMax

▸ set_sqlMinMax(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/editors/datetimeeditor.ts:290

---

set_value

▸ set_value(value): void

Parameters

Name	Type
value	string

Returns

void

Implementation of

IStringValue.set_value

Defined in

src/ui/editors/datetimeeditor.ts:182

---

set_valueAsDate

▸ Private set_valueAsDate(value): void

Parameters

Name	Type
value	Date

Returns

void

Defined in

src/ui/editors/datetimeeditor.ts:238

---

create

▸ Static create<TWidget, TOpt>(params): TWidget

Type parameters

Name	Type
TWidget	extends Widget<TOpt, TWidget>
TOpt	TOpt

Parameters

Name	Type
params	CreateWidgetParams<TWidget, TOpt>

Returns

TWidget

Inherited from

Widget.create

Defined in

src/ui/widgets/widget.ts:153

---

elementFor

▸ Static elementFor<TWidget>(editorType): JQuery

Type parameters

Name
TWidget

Parameters

Name	Type
editorType	(...args: any[]) => TWidget

Returns

JQuery

Inherited from

Widget.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:124

---

roundToMinutes

▸ Static roundToMinutes(date, minutesStep): Date

Parameters

Name	Type
date	Date
minutesStep	number

Returns

Date

Defined in

src/ui/editors/datetimeeditor.ts:323