Class AbstractFlatpickr<C>`Abstract`

Defines the interface for Datepicker Pattern Based on Flatpickr provider

Type Parameters

C extends AbstractFlatpickrConfig

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractDatePicker<Flatpickr, C>
- AbstractFlatpickr
  - OSUIFlatpickrRangeDate
  - OSUIFlatpickrSingleDate

Implements

IFlatpickr

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Private` _a11yInfoContainerElem

_a11yInfoContainerElem: HTMLElement

`Private` _bodyScrollCommonBehaviour

_bodyScrollCommonBehaviour: UpdatePositionOnScroll

`Private` _providerFocusSpanTarget

_providerFocusSpanTarget: HTMLElement

`Private` _todayButtonElem

_todayButtonElem: HTMLElement

`Private` _zindexCommonBehavior

_zindexCommonBehavior: UpdateZindex

`Protected` datePickerPlatformInputElem

datePickerPlatformInputElem: HTMLInputElement

`Protected` flatpickrInputElem

flatpickrInputElem: HTMLInputElement

`Protected` flatpickrOpts

flatpickrOpts: FlatpickrOptions

`Protected` onSelectedCallbackEvent

onSelectedCallbackEvent: OSFramework.OSUI.Patterns.DatePicker.Callbacks.OSOnChangeEvent

onCloseCustomCallback

onCloseCustomCallback: any = undefined

Methods

`Protected` finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractDatePicker.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected` triggerPlatformEventCallback

triggerPlatformEventCallback(platFormCallback: OSGeneric, ...args: unknown[]): void
Protected
Triggers a generic platform event.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractDatePicker.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Memberof
AbstractPattern

Returns void
Inherited from AbstractDatePicker.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected` unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractDatePicker.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of IFlatpickr.equalsToID

Inherited from AbstractDatePicker.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Protected` redraw

redraw(): void
Protected
Method that will be responsible to redraw pattern when needed

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractDatePicker.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:107

checkAddedProviderEvents

checkAddedProviderEvents(): void
Method to check for pending events to be added

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractDatePicker.checkAddedProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:156

checkPendingProviderEvents

checkPendingProviderEvents(): void
Method to check for saved events to be added after a destroy/init cycle

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractDatePicker.checkPendingProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:170

setProviderEvent

setProviderEvent(eventName: string, callback: Generic, uniqueId: string, saveEvent??: boolean): void
Method to add a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- Optional saveEvent: boolean = true
Returns void
Implementation of IFlatpickr.setProviderEvent

Inherited from AbstractDatePicker.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:235

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventId: string
Returns void
Implementation of IFlatpickr.unsetProviderEvent

Inherited from AbstractDatePicker.unsetProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:268

updateProviderEvents

updateProviderEvents(providerInfo: ProviderInfo): void
Method to update the provider events API instance and save/pending events

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- providerInfo: ProviderInfo
Returns void
Implementation of IFlatpickr.updateProviderEvents

Inherited from AbstractDatePicker.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:295

`Private` _setAttributes

_setAttributes(): void
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:38

`Private` _setCalendarCssClasses

_setCalendarCssClasses(): void
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:61

`Private` _setParentMinHeight

_setParentMinHeight(): void
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:78

`Private` _todayButtonKeydown

_todayButtonKeydown(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:87

`Private` _unsetParentMinHeight

_unsetParentMinHeight(): void
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:105

`Protected` addTodayBtn

addTodayBtn(): void
Protected
Method used to add the TodayButton at calendar

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:118

`Protected` createProviderInstance

createProviderInstance(): void
Protected
Method that will be triggered at Flatpickr instance is ready

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:155

`Protected` jumpIntoToday

jumpIntoToday(): void
Protected
Trigger the jumToDate to now

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:226

`Protected` onDatePickerClose

onDatePickerClose(): void
Protected
Method used to update the datepicker value when the selected dates is empty And to add the custom callback to the OnClose event

Memberof
AbstractFlatpickr

Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:237

`Protected` prepareConfigs

prepareConfigs(): void
Protected
The method used to prepare the pattern before being redrawn in order to prevent possible flickering.

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Overrides AbstractDatePicker.prepareConfigs
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:258

`Protected` prepareToAndRedraw

prepareToAndRedraw(): void
Protected
Method used to prepare pattern before being redrawed in order to prevent possible flickerings!

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:272

`Protected` setA11YProperties

setA11YProperties(): void
Protected
This method has no implementation on this pattern context!

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Overrides AbstractDatePicker.setA11YProperties
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:283

`Protected` setCallbacks

setCallbacks(): void
Protected
This method has no implementation on this pattern context!

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Overrides AbstractDatePicker.setCallbacks
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:350

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to set the html elements used

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Overrides AbstractDatePicker.setHtmlElements
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:360

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Overrides AbstractDatePicker.unsetCallbacks
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:381

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Unsets the refences to the HTML elements.

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Overrides AbstractDatePicker.unsetHtmlElements
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:394

build

build(): void
Build the Pattern

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Implementation of IFlatpickr.build

Overrides AbstractDatePicker.build
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:404

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method used to change given propertyName at OnParametersChange platform event

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- propertyName: string
  
  the name of the property that will be changed
- propertyValue: unknown
  
  the new value that should be assigned to the given property name
Returns void
Implementation of IFlatpickr.changeProperty

Overrides AbstractDatePicker.changeProperty
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:417

clear

clear(): void
Method used to clear the selected date

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Implementation of IFlatpickr.clear

Overrides AbstractDatePicker.clear
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:450

close

close(): void
Method used to close DatePicker

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Implementation of IFlatpickr.close

Overrides AbstractDatePicker.close
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:462

disableDays

disableDays(disableDays: string[]): void
Method used to disable days on DatePicker

Memberof
Flatpickr.DisableDays
Parameters
- disableDays: string[]
Returns void
Implementation of IFlatpickr.disableDays

Overrides AbstractDatePicker.disableDays
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:477

disableWeekDays

disableWeekDays(disableWeekDays: number[]): void
Method used to disable weekdays on DatePicker

Memberof
Flatpickr.DisableWeekDays
Parameters
- disableWeekDays: number[]
Returns void
Implementation of IFlatpickr.disableWeekDays

Overrides AbstractDatePicker.disableWeekDays
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:488

dispose

dispose(): void
Method to remove and destroy DatePicker instance

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Implementation of IFlatpickr.dispose

Overrides AbstractDatePicker.dispose
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:499

open

open(): void
Method used to open DatePicker

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Implementation of IFlatpickr.open

Overrides AbstractDatePicker.open
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:521

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method used to regist callback events

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IFlatpickr.registerCallback

Overrides AbstractDatePicker.registerCallback
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:542

setEditableInput

setEditableInput(isEditable: boolean): void
Method used to set the DatePicker as editable on its input

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- isEditable: boolean
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:559

setLanguage

setLanguage(value: string): void
Method used to set the DatePicker language

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- value: string
Returns void
Implementation of IFlatpickr.setLanguage

Overrides AbstractDatePicker.setLanguage
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:571

setProviderConfigs

setProviderConfigs(newConfigs: FlatpickrOptions): void
Method used to set all the extended Flatpickr properties across the different types of instances

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- newConfigs: FlatpickrOptions
Returns void
Implementation of IFlatpickr.setProviderConfigs

Overrides AbstractDatePicker.setProviderConfigs
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:587

updatePrompt

updatePrompt(promptMessage: string): void
Method used to update the prompt message

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- promptMessage: string
  
  The new prompt message value
Returns void
Implementation of IFlatpickr.updatePrompt

Overrides AbstractDatePicker.updatePrompt
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:599

`Protected` `Abstract` onDateSelectedEvent

onDateSelectedEvent(selectedDates: Date[]): void
Parameters
- selectedDates: Date[]
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:604

`Protected` `Abstract` todayBtnClick

todayBtnClick(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:605

`Protected` `Abstract` updatePlatformInputAttrs

updatePlatformInputAttrs(): void
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:606

`Abstract` updateInitialDate

updateInitialDate(start: string, end?: string): void
Parameters
- start: string
- Optional end: string
Returns void
Implementation of IFlatpickr.updateInitialDate

Overrides AbstractDatePicker.updateInitialDate
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:608

Accessors

`Protected` _enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from OSFramework.OSUI.Patterns.DatePicker.AbstractDatePicker._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of IFlatpickr.selfElement

Inherited from OSFramework.OSUI.Patterns.DatePicker.AbstractDatePicker.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of IFlatpickr.isBuilt

Inherited from OSFramework.OSUI.Patterns.DatePicker.AbstractDatePicker.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from OSFramework.OSUI.Patterns.DatePicker.AbstractDatePicker.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IFlatpickr.uniqueId

Inherited from OSFramework.OSUI.Patterns.DatePicker.AbstractDatePicker.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IFlatpickr.widgetId

Inherited from OSFramework.OSUI.Patterns.DatePicker.AbstractDatePicker.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Implementation of IFlatpickr.providerInfo

Inherited from OSFramework.OSUI.Patterns.DatePicker.AbstractDatePicker.providerInfo
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:318

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Implementation of IFlatpickr.provider

Inherited from OSFramework.OSUI.Patterns.DatePicker.AbstractDatePicker.provider
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:347

Constructors

constructor

new AbstractFlatpickr<C>(uniqueId: string, configs: C): AbstractFlatpickr<C>
Type Parameters
- C extends AbstractFlatpickrConfig<C>
Parameters
- uniqueId: string
- configs: C
Returns AbstractFlatpickr<C>
Overrides AbstractDatePicker.constructor
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:27

Class AbstractFlatpickr<C>Abstract

Type Parameters

C extends AbstractFlatpickrConfig

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Protected providerEventsManagerInstance

Private _a11yInfoContainerElem

Private _bodyScrollCommonBehaviour

Private _providerFocusSpanTarget

Private _todayButtonElem

Private _zindexCommonBehavior

Protected datePickerPlatformInputElem

Protected flatpickrInputElem

Protected flatpickrOpts

Protected onSelectedCallbackEvent

onCloseCustomCallback

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected redraw

Memberof

Returns void

checkAddedProviderEvents

Memberof

Returns void

checkPendingProviderEvents

Memberof

Returns void

setProviderEvent

Returns

Memberof

Parameters

eventName: string

callback: Generic

uniqueId: string

Optional saveEvent: boolean = true

Returns void

unsetProviderEvent

Returns

Memberof

Parameters

eventId: string

Returns void

updateProviderEvents

Memberof

Parameters

providerInfo: ProviderInfo

Returns void

Private _setAttributes

Returns void

Private _setCalendarCssClasses

Returns void

Class AbstractFlatpickr<C>`Abstract`

`Protected` isProviderBased

`Protected` providerEventsManagerInstance

`Private` _a11yInfoContainerElem

`Private` _bodyScrollCommonBehaviour

`Private` _providerFocusSpanTarget

`Private` _todayButtonElem

`Private` _zindexCommonBehavior

`Protected` datePickerPlatformInputElem

`Protected` flatpickrInputElem

`Protected` flatpickrOpts

`Protected` onSelectedCallbackEvent

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` redraw

`Optional` saveEvent: boolean = true

`Private` _setAttributes

`Private` _setCalendarCssClasses

`Private` _setParentMinHeight

`Private` _todayButtonKeydown

`Private` _unsetParentMinHeight

`Protected` addTodayBtn

`Protected` createProviderInstance

`Protected` jumpIntoToday

`Protected` onDatePickerClose

`Protected` prepareConfigs

`Protected` prepareToAndRedraw

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements