Class OSUIFlatpickrRangeDate

Defines the interface for Datepicker Pattern Based on Flatpickr provider

Hierarchy-Diagram

UML class diagram of OSUIFlatpickrRangeDate

Legend

class

abstract class

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractFlatpickr<FlatpickrRangeDateConfig>
- OSUIFlatpickrRangeDate

Index

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/Pattern/AbstractPattern.ts:50

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/Pattern/AbstractPattern.ts:115

`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/Pattern/AbstractProviderPattern.ts:92

`Protected` triggerPlatformEventInitialized

triggerPlatformEventInitialized(platFormCallback: OSGeneric): void
Trigger platform's InstanceIntializedHandler client Action

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
Returns void
Inherited from AbstractFlatpickr.triggerPlatformEventInitialized
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:111

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/Pattern/AbstractProviderPattern.ts:137

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/Pattern/AbstractProviderPattern.ts:151

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/Pattern/AbstractProviderPattern.ts:181

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/Pattern/AbstractProviderPattern.ts:214

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/Pattern/AbstractProviderPattern.ts:241

`Protected` addTodayBtn

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

`Protected` createProviderInstance

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

`Protected` jumpIntoToday

jumpIntoToday(): void
Protected
Trigger the jumToDate to now

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

`Protected` prepareConfigs

prepareConfigs(): void
Protected
Method that will set the provider configurations in order to properly create its instance

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.prepareConfigs
- Defined in Providers/Datepicker/Flatpickr/AbstractFlatpickr.ts:185

`Protected` prepareToAndRedraw

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

Returns void
Inherited from AbstractFlatpickr.prepareToAndRedraw
- Defined in Providers/Datepicker/Flatpickr/AbstractFlatpickr.ts:199

`Protected` setA11YProperties

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

`Protected` setCallbacks

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

`Protected` setHtmlElements

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

`Protected` unsetHtmlElements

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

clear

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

close

close(): void
Method used to close DatePicker

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

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/Datepicker/Flatpickr/AbstractFlatpickr.ts:363

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/Datepicker/Flatpickr/AbstractFlatpickr.ts:374

dispose

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

open

open(): void
Method used to open DatePicker

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr

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

registerCallback

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Inherited from AbstractFlatpickr.registerCallback
- Defined in Providers/Datepicker/Flatpickr/AbstractFlatpickr.ts:418

setEditableInput

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- isEditable: boolean
Returns void
Inherited from AbstractFlatpickr.setEditableInput
- Defined in Providers/Datepicker/Flatpickr/AbstractFlatpickr.ts:438

setLanguage

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

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

setProviderConfigs

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- newConfigs: FlatpickrOptions
Returns void
Inherited from AbstractFlatpickr.setProviderConfigs
- Defined in Providers/Datepicker/Flatpickr/AbstractFlatpickr.ts:466

toggleNativeBehavior

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

Memberof
Providers.DatePicker.Flatpickr.AbstractFlatpickr
Parameters
- isNative: boolean
Returns void
Inherited from AbstractFlatpickr.toggleNativeBehavior
- Defined in Providers/Datepicker/Flatpickr/AbstractFlatpickr.ts:477

`Private` _onUpdateDateFormat

_onUpdateDateFormat(): void
Returns void
- Defined in Providers/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:12

`Private` _updateInitialStartAndEndDates

_updateInitialStartAndEndDates(): void
Returns void
- Defined in Providers/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:34

`Protected` onDateSelectedEvent

onDateSelectedEvent(selectedDates: string[]): 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.DatePicker.Flatpickr.RangeDate.OSUIFlatpickrRangeDate
Parameters
- selectedDates: string[]
  
  Array of selected dates
Returns void
Overrides AbstractFlatpickr.onDateSelectedEvent
- Defined in Providers/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:65

`Protected` todayBtnClick

todayBtnClick(event: MouseEvent): void
Protected
Trigger the jumpToDate to now

Memberof
Providers.DatePicker.Flatpickr.RangeDate.OSUIFlatpickrRangeDate
Parameters
- event: MouseEvent
Returns void
Overrides AbstractFlatpickr.todayBtnClick
- Defined in Providers/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:99

`Protected` updatePlatformInputAttrs

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

Memberof
Providers.DatePicker.Flatpickr.RangeDate.OSUIFlatpickrRangeDate

Returns void
Overrides AbstractFlatpickr.updatePlatformInputAttrs
- Defined in Providers/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:111

build

build(): void
Builds the Pattern

Memberof
Providers.DatePicker.Flatpickr.RangeDate.OSUIFlatpickrRangeDate

Returns void
Overrides AbstractFlatpickr.build
- Defined in Providers/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:126

changeProperty

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

Memberof
Providers.DatePicker.Flatpickr.RangeDate.OSUIFlatpickrRangeDate
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/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:141

updateInitialDate

updateInitialDate(startDate: string, endDate: string): void
Method used to update the StartInitialDate and EndInitialDate values

Memberof
Providers.DatePicker.Flatpickr.RangeDate.OSUIFlatpickrRangeDate
Parameters
- startDate: string
  
  The new StartInitialDate value
- endDate: string
  
  The new EndInitialDate value
Returns void
Overrides AbstractFlatpickr.updateInitialDate
- Defined in Providers/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:165

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/Pattern/AbstractPattern.ts:128

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/Pattern/AbstractPattern.ts:139

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/Pattern/AbstractPattern.ts:150

configs

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractFlatpickr.configs
- Defined in OSFramework/Pattern/AbstractPattern.ts:161

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/Pattern/AbstractPattern.ts:172

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/Pattern/AbstractPattern.ts:183

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

Properties

`Protected` _provider

_provider: flatpickr

`Protected` _providerInfo

_providerInfo: ProviderInfo

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Protected` _datePickerPlatformInputElem

_datePickerPlatformInputElem: HTMLInputElement

`Protected` _flatpickrInputElem

_flatpickrInputElem: HTMLInputElement

`Protected` _flatpickrOpts

_flatpickrOpts: FlatpickrOptions

`Protected` _onSelectedCallbackEvent

_onSelectedCallbackEvent: OSFramework.Patterns.DatePicker.Callbacks.OSOnChangeEvent

Constructors

constructor

new OSUIFlatpickrRangeDate(uniqueId: string, configs: JSON): OSUIFlatpickrRangeDate
Parameters
- uniqueId: string
- configs: JSON
Returns OSUIFlatpickrRangeDate
Overrides AbstractFlatpickr.constructor
- Defined in Providers/Datepicker/Flatpickr/RangeDate/FlatpickrRangeDate.ts:7

Class OSUIFlatpickrRangeDate

Hierarchy-Diagram

Legend

Hierarchy

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected redraw

Memberof

Returns void

Protected triggerPlatformEventInitialized

Memberof

Parameters

platFormCallback: OSGeneric

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 prepareConfigs

Memberof

Returns void

Protected prepareToAndRedraw

Memberof

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

`Protected` finishBuild

`Protected` redraw

`Protected` triggerPlatformEventInitialized

`Optional` saveEvent: boolean = true

`Protected` addTodayBtn

`Protected` createProviderInstance

`Protected` jumpIntoToday

`Protected` prepareConfigs

`Protected` prepareToAndRedraw

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Private` _onUpdateDateFormat

`Private` _updateInitialStartAndEndDates

`Protected` onDateSelectedEvent

`Protected` todayBtnClick

`Protected` updatePlatformInputAttrs