Class OSUIFlatpickrSingleDate

Defines the interface for Datepicker Pattern Based on Flatpickr provider

Hierarchy-Diagram

UML class diagram of OSUIFlatpickrSingleDate

Legend

class

abstract class

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractFlatpickr<FlatpickrSingleDateConfig>
- OSUIFlatpickrSingleDate

Index

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

`Private` _isUpdatedInitialDateByClientAction

_isUpdatedInitialDateByClientAction: boolean = false

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractFlatpickr.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 AbstractFlatpickr.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 AbstractFlatpickr.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 AbstractFlatpickr.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
Inherited from AbstractFlatpickr.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 AbstractFlatpickr.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:132

checkAddedProviderEvents

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

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractFlatpickr.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

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractFlatpickr.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

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- Optional saveEvent: boolean = true
Returns void
Inherited from AbstractFlatpickr.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:262

unsetProviderEvent

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

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventId: string
Returns void
Inherited from AbstractFlatpickr.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

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- providerInfo: ProviderInfo
Returns void
Inherited from AbstractFlatpickr.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:322

`Protected` addTodayBtn

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.addTodayBtn
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:143

`Protected` createProviderInstance

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.createProviderInstance
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:187

`Protected` jumpIntoToday

jumpIntoToday(): void
Protected
Trigger the jumToDate to now

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.jumpIntoToday
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:258

`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

Memberof
AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.onDatePickerClose
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:269

`Protected` onDatePickerOpen

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

Memberof
AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.onDatePickerOpen
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:296

`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
Inherited from AbstractFlatpickr.prepareConfigs
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:311

`Protected` setA11YProperties

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.setA11YProperties
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:336

`Protected` setCallbacks

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.setCallbacks
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:399

`Protected` setHtmlElements

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.setHtmlElements
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:409

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.unsetCallbacks
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:432

`Protected` unsetHtmlElements

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.unsetHtmlElements
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:445

clear

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.clear
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:501

close

close(): void
Method used to close DatePicker

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.close
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:513

disableDays

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

Memberof
Flatpickr.DisableDays
Parameters
- disableDays: string[]
Returns void
Inherited from AbstractFlatpickr.disableDays
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:528

disableWeekDays

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

Memberof
Flatpickr.DisableWeekDays
Parameters
- disableWeekDays: number[]
Returns void
Inherited from AbstractFlatpickr.disableWeekDays
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:539

dispose

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.dispose
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:550

onRender

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

Memberof
AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.onRender
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:572

open

open(): void
Method used to open DatePicker

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.open
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:588

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
Inherited from AbstractFlatpickr.registerCallback
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:609

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
Inherited from AbstractFlatpickr.setEditableInput
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:626

setLanguage

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- value: string
Returns void
Inherited from AbstractFlatpickr.setLanguage
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:638

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
Inherited from AbstractFlatpickr.setProviderConfigs
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:654

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
Inherited from AbstractFlatpickr.updatePrompt
- Defined in Providers/OSUI/Datepicker/Flatpickr/AbstractFlatpickr.ts:666

`Private` _checkInitialDate

_checkInitialDate(): void
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:15

`Protected` onDateSelectedEvent

onDateSelectedEvent(selectedDates: Date[]): void
Protected
Method that will be triggered by library each time any date is selected and will also trigger the input update value and also trigger the OnSelectedDate platform event callback!

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.OSUIFlatpickrSingleDate
Parameters
- selectedDates: Date[]
  
  Array of selected dates
Returns void
Overrides AbstractFlatpickr.onDateSelectedEvent
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:56

`Protected` prepareToAndRedraw

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.OSUIFlatpickrSingleDate

Returns void
Overrides AbstractFlatpickr.prepareToAndRedraw
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:87

`Protected` todayBtnClick

todayBtnClick(event: MouseEvent): void
Protected
Trigger the jumToDate to now and trigger the Now as a selected Date!

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.OSUIFlatpickrSingleDate
Parameters
- event: MouseEvent
Returns void
Overrides AbstractFlatpickr.todayBtnClick
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:100

`Protected` updatePlatformInputAttrs

updatePlatformInputAttrs(): void
Protected
Update platform input attributes in order to maintain consistency with data type!

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.OSUIFlatpickrSingleDate

Returns void
Overrides AbstractFlatpickr.updatePlatformInputAttrs
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:114

build

build(): void
Builds the Pattern

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.OSUIFlatpickrSingleDate

Returns void
Overrides AbstractFlatpickr.build
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:135

changeProperty

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

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.OSUIFlatpickrSingleDate
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
Overrides AbstractFlatpickr.changeProperty
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:148

toggleNativeBehavior

toggleNativeBehavior(isNative: boolean): void
Method used to toggle the default native behavior of DatePicker

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.OSUIFlatpickrSingleDate
Parameters
- isNative: boolean
Returns void
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:210

updateInitialDate

updateInitialDate(value: string): void
Method used to update the InitialDate config value

Memberof
Providers.OSUI.DatePicker.Flatpickr.SingleDate.OSUIFlatpickrSingleDate
Parameters
- value: string
  
  The new InitialDate value that will be set
Returns void
Overrides AbstractFlatpickr.updateInitialDate
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:224

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractFlatpickr._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
Inherited from AbstractFlatpickr.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
Inherited from AbstractFlatpickr.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 AbstractFlatpickr.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
Inherited from AbstractFlatpickr.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
Inherited from AbstractFlatpickr.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Inherited from AbstractFlatpickr.providerInfo
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:345

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Inherited from AbstractFlatpickr.provider
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:374

Constructors

constructor

new OSUIFlatpickrSingleDate(uniqueId: string, configs: JSON): OSUIFlatpickrSingleDate
Parameters
- uniqueId: string
- configs: JSON
Returns OSUIFlatpickrSingleDate
Overrides AbstractFlatpickr.constructor
- Defined in Providers/OSUI/Datepicker/Flatpickr/SingleDate/FlatpickrSingleDate.ts:10

Class OSUIFlatpickrSingleDate

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Protected providerEventsManagerInstance

Protected datePickerPlatformInputElem

Protected flatpickrInputElem

Protected flatpickrOpts

Protected onSelectedCallbackEvent

onCloseCustomCallback

Private _isUpdatedInitialDateByClientAction

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

Protected addTodayBtn

Memberof

Returns void

Protected createProviderInstance

Memberof

Returns void

Protected jumpIntoToday

Memberof

Returns void

Protected onDatePickerClose

Memberof

`Protected` isProviderBased

`Protected` providerEventsManagerInstance

`Protected` datePickerPlatformInputElem

`Protected` flatpickrInputElem

`Protected` flatpickrOpts

`Protected` onSelectedCallbackEvent

`Private` _isUpdatedInitialDateByClientAction

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` redraw

`Optional` saveEvent: boolean = true

`Protected` addTodayBtn

`Protected` createProviderInstance

`Protected` jumpIntoToday

`Protected` onDatePickerClose

`Protected` onDatePickerOpen

`Protected` prepareConfigs

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements