Class AbstractFlatpickr<C>`Abstract`

Defines the interface for Datepicker Pattern Based on Flatpickr provider

Index

Constructors

constructor

Properties

isProviderBased providerEventsManagerInstance datePickerPlatformInputElem flatpickrInputElem flatpickrOpts onSelectedCallbackEvent onCloseCustomCallback

Accessors

_enableAccessibility selfElement isBuilt configs uniqueId widgetId providerInfo provider

Constructors

constructor

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`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

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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

Returns ProviderInfo

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickr.providerInfo

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

provider

get provider(): P
Provider getter

Returns P

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickr.provider

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

Methods

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractDatePicker.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

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

Returns void

Memberof
AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractDatePicker.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:132

checkAddedProviderEvents

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractDatePicker.checkAddedProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:181

checkPendingProviderEvents

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractDatePicker.checkPendingProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:195

setProviderEvent

setProviderEvent(
    eventName: string,
    callback: Generic,
    uniqueId: string,
    saveEvent?: boolean,
): void
Method to add a provider event using extensibility
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- OptionalsaveEvent: boolean = true
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickr.setProviderEvent

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

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility
Parameters
- eventId: string
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickr.unsetProviderEvent

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

updateProviderEvents

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

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickr.updateProviderEvents

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

`Protected`addTodayBtn

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:195

`Protected`createProviderInstance

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:239

`Protected`jumpIntoToday

jumpIntoToday(): void
Protected
Trigger the jumToDate to now

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:305

`Protected`onDatePickerClose

onDatePickerClose(): void
Protected
Method used to update the datepicker value when the selected dates are empty, to add the custom callback to the OnClose event and remove the tabindex from the today button

Returns void

Memberof
AbstractFlatpickr
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:317

`Protected`onDatePickerOpen

onDatePickerOpen(): void
Protected
Method used to add the custom callback to the OnOpen event and add the tabindex for the today button

Returns void

Memberof
AbstractFlatpickr
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:344

`Protected`prepareConfigs

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Overrides AbstractDatePicker.prepareConfigs
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:359

`Protected`prepareToAndRedraw

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:373

`Protected`setA11YProperties

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Overrides AbstractDatePicker.setA11YProperties
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:384

`Protected`setCallbacks

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Overrides AbstractDatePicker.setCallbacks
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:455

`Protected`setHtmlElements

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Overrides AbstractDatePicker.setHtmlElements
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:465

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Overrides AbstractDatePicker.unsetCallbacks
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:488

`Protected`unsetHtmlElements

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Overrides AbstractDatePicker.unsetHtmlElements
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:501

build

build(): void
Build the Pattern

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.build

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

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method used to change given propertyName at OnParametersChange platform event
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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.changeProperty

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

clear

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.clear

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

close

close(): void
Method used to close DatePicker

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.close

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

disableDays

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

Memberof
Flatpickr.DisableDays
Implementation of IFlatpickr.disableDays

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

disableWeekDays

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

Memberof
AbstractFlatpickr
Implementation of IFlatpickr.disableWeekDays

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

dispose

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

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.dispose

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

onRender

onRender(): void
Method used to update certain properties at OnRender

Returns void

Memberof
AbstractFlatpickr
Implementation of IFlatpickr.onRender

Overrides AbstractDatePicker.onRender
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:628

open

open(): void
Method used to open DatePicker

Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.open

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

registerCallback

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.registerCallback

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

setEditableInput

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:682

setLanguage

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

Memberof
AbstractFlatpickr
Implementation of IFlatpickr.setLanguage

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

setProviderConfigs

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.setProviderConfigs

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

updatePrompt

updatePrompt(promptMessage: string): void
Method used to update the prompt message
Parameters
- promptMessage: string
  The new prompt message value
Returns void

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Implementation of IFlatpickr.updatePrompt

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

`Protected` `Abstract`onDateSelectedEvent

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

`Protected` `Abstract`todayBtnClick

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

`Protected` `Abstract`updatePlatformInputAttrs

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

`Abstract`updateInitialDate

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

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

Class AbstractFlatpickr<C>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractFlatpickr<C>

Properties

ProtectedisProviderBased

ProtectedproviderEventsManagerInstance

ProtecteddatePickerPlatformInputElem

ProtectedflatpickrInputElem

ProtectedflatpickrOpts

ProtectedonSelectedCallbackEvent

onCloseCustomCallback

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

providerInfo

Returns ProviderInfo

Memberof

provider

Returns P

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

Protectedredraw

Returns void

Memberof

checkAddedProviderEvents

Returns void

Memberof

checkPendingProviderEvents

Returns void

Memberof

setProviderEvent

Parameters

Returns void

Memberof

unsetProviderEvent

Parameters

Class AbstractFlatpickr<C>`Abstract`

`Protected`isProviderBased

`Protected`providerEventsManagerInstance

`Protected`datePickerPlatformInputElem

`Protected`flatpickrInputElem

`Protected`flatpickrOpts

`Protected`onSelectedCallbackEvent

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`redraw

`Protected`addTodayBtn

`Protected`createProviderInstance

`Protected`jumpIntoToday

`Protected`onDatePickerClose

`Protected`onDatePickerOpen

`Protected`prepareConfigs

`Protected`prepareToAndRedraw

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements