@serenity-is/corelib / DateTimeEditor
Class: DateTimeEditor<P>
Type parameters
Name | Type |
---|---|
P |
extends DateTimeEditorOptions = DateTimeEditorOptions |
Hierarchy
EditorWidget
<P
>↳
DateTimeEditor
Implements
Table of contents
Constructors
Properties
Accessors
Methods
- addCssClass
- addValidationRule
- change
- changeSelect2
- createFlatPickrTrigger
- destroy
- getCssClass
- getCustomAttribute
- getFieldElement
- getFlatpickrOptions
- getGridField
- get_maxDate
- get_maxValue
- get_minDate
- get_minValue
- get_readOnly
- get_sqlMinMax
- get_value
- init
- internalInit
- internalRenderContents
- render
- renderContents
- set_maxDate
- set_maxValue
- set_minDate
- set_minValue
- set_readOnly
- set_sqlMinMax
- set_value
- syncOrAsyncThen
- useIdPrefix
- create
- createDefaultElement
- getWidgetName
- roundToMinutes
Constructors
constructor
• new DateTimeEditor<P
>(props
): DateTimeEditor
<P
>
Type parameters
Name | Type |
---|---|
P |
extends DateTimeEditorOptions = DateTimeEditorOptions |
Parameters
Name | Type |
---|---|
props |
EditorProps <P > |
Returns
Overrides
Defined in
src/ui/editors/datetimeeditor.ts:20
Properties
domNode
• Readonly
domNode: HTMLInputElement
Overrides
Defined in
src/ui/editors/datetimeeditor.ts:14
idPrefix
• Readonly
idPrefix: string
Inherited from
Defined in
options
• Protected
Readonly
options: WidgetProps
<EditorProps
<P
>>
Inherited from
Defined in
uniqueName
• Protected
Readonly
uniqueName: string
Inherited from
Defined in
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:367
typeInfo
▪ Static
typeInfo: ClassTypeInfo
<"Serenity.EditorWidget"
>
Inherited from
Defined in
Accessors
element
• get
element(): Fluent
<HTMLElement
>
Returns a Fluent(this.domNode) object
Returns
Fluent
<HTMLElement
>
Inherited from
EditorWidget.element
Defined in
props
• get
props(): WidgetProps
<P
>
Returns
WidgetProps
<P
>
Inherited from
EditorWidget.props
Defined in
value
• get
value(): string
Returns
string
Defined in
src/ui/editors/datetimeeditor.ts:218
• set
value(v
): void
Parameters
Name | Type |
---|---|
v |
string |
Returns
void
Defined in
src/ui/editors/datetimeeditor.ts:262
valueAsDate
• get
valueAsDate(): Date
Returns
Date
Defined in
src/ui/editors/datetimeeditor.ts:273
• set
valueAsDate(value
): void
Parameters
Name | Type |
---|---|
value |
Date |
Returns
void
Defined in
src/ui/editors/datetimeeditor.ts:285
Methods
addCssClass
▸ addCssClass(): void
Returns
void
Inherited from
Defined in
addValidationRule
▸ addValidationRule(rule
, uniqueName?
): void
Parameters
Name | Type |
---|---|
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
uniqueName? |
string |
Returns
void
Inherited from
EditorWidget.addValidationRule
Defined in
▸ addValidationRule(uniqueName
, rule
): void
Parameters
Name | Type |
---|---|
uniqueName |
string |
rule |
(input : HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement ) => string |
Returns
void
Inherited from
EditorWidget.addValidationRule
Defined in
change
▸ change(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Inherited from
Defined in
changeSelect2
▸ changeSelect2(handler
): void
Parameters
Name | Type |
---|---|
handler |
(e : Event ) => void |
Returns
void
Inherited from
Defined in
createFlatPickrTrigger
▸ createFlatPickrTrigger(): HTMLElement
Returns
HTMLElement
Defined in
src/ui/editors/datetimeeditor.ts:187
destroy
▸ destroy(): void
Returns
void
Overrides
Defined in
src/ui/editors/datetimeeditor.ts:145
getCssClass
▸ getCssClass(): string
Returns
string
Inherited from
Defined in
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
EditorWidget.getCustomAttribute
Defined in
getFieldElement
▸ getFieldElement(): HTMLElement
Returns
HTMLElement
Inherited from
Defined in
getFlatpickrOptions
▸ getFlatpickrOptions(): any
Returns
any
Defined in
src/ui/editors/datetimeeditor.ts:152
getGridField
▸ getGridField(): Fluent
<HTMLElement
>
Returns
Fluent
<HTMLElement
>
Inherited from
Defined in
get_maxDate
▸ get_maxDate(): Date
Returns
Date
Defined in
src/ui/editors/datetimeeditor.ts:313
get_maxValue
▸ get_maxValue(): string
Returns
string
Defined in
src/ui/editors/datetimeeditor.ts:297
get_minDate
▸ get_minDate(): Date
Returns
Date
Defined in
src/ui/editors/datetimeeditor.ts:305
get_minValue
▸ get_minValue(): string
Returns
string
Defined in
src/ui/editors/datetimeeditor.ts:289
get_readOnly
▸ get_readOnly(): boolean
Returns
boolean
Implementation of
Defined in
src/ui/editors/datetimeeditor.ts:336
get_sqlMinMax
▸ get_sqlMinMax(): boolean
Returns
boolean
Defined in
src/ui/editors/datetimeeditor.ts:321
get_value
▸ get_value(): string
Returns
string
Implementation of
Defined in
src/ui/editors/datetimeeditor.ts:193
init
▸ init(): this
Returns
this
Inherited from
Defined in
internalInit
▸ internalInit(): void
Returns
void
Inherited from
Defined in
internalRenderContents
▸ internalRenderContents(): void
Returns
void
Inherited from
EditorWidget.internalRenderContents
Defined in
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
Defined in
renderContents
▸ renderContents(): any
Returns
any
Inherited from
Defined in
set_maxDate
▸ set_maxDate(value
): void
Parameters
Name | Type |
---|---|
value |
Date |
Returns
void
Defined in
src/ui/editors/datetimeeditor.ts:317
set_maxValue
▸ set_maxValue(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/datetimeeditor.ts:301
set_minDate
▸ set_minDate(value
): void
Parameters
Name | Type |
---|---|
value |
Date |
Returns
void
Defined in
src/ui/editors/datetimeeditor.ts:309
set_minValue
▸ set_minValue(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Defined in
src/ui/editors/datetimeeditor.ts:293
set_readOnly
▸ set_readOnly(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Implementation of
Defined in
src/ui/editors/datetimeeditor.ts:340
set_sqlMinMax
▸ set_sqlMinMax(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Defined in
src/ui/editors/datetimeeditor.ts:325
set_value
▸ set_value(value
): void
Parameters
Name | Type |
---|---|
value |
string |
Returns
void
Implementation of
Defined in
src/ui/editors/datetimeeditor.ts:222
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
Defined in
useIdPrefix
▸ useIdPrefix(): IdPrefixType
Returns
Inherited from
Defined in
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
Defined in
createDefaultElement
▸ createDefaultElement(): HTMLInputElement
Returns
HTMLInputElement
Overrides
EditorWidget.createDefaultElement
Defined in
src/ui/editors/datetimeeditor.ts:13
getWidgetName
▸ getWidgetName(type
): string
Parameters
Name | Type |
---|---|
type |
Function |
Returns
string
Inherited from
Defined in
roundToMinutes
▸ roundToMinutes(date
, minutesStep
): Date
Parameters
Name | Type |
---|---|
date |
Date |
minutesStep |
number |
Returns
Date