Class OSUIFlatpickrMonth

Defines the interface for MonthPicker Pattern Based on Flatpickr provider

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractMonthPicker<Flatpickr, FlatpickrMonthConfig>
- OSUIFlatpickrMonth

Implements

IFlatpickrMonth

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Private` _a11yInfoContainerElem

_a11yInfoContainerElem: HTMLElement

`Private` _bodyOnClickGlobalEvent

_bodyOnClickGlobalEvent: IListener

`Private` _bodyScrollCommonBehaviour

_bodyScrollCommonBehaviour: UpdatePositionOnScroll

`Private` _flatpickrOpts

_flatpickrOpts: FlatpickrOptions

`Private` _isPlatformInputDisabled

_isPlatformInputDisabled: boolean

`Private` _zindexCommonBehavior

_zindexCommonBehavior: UpdateZindex

`Protected` flatpickrInputElem

flatpickrInputElem: HTMLInputElement

`Protected` monthPickerPlatformInputElem

monthPickerPlatformInputElem: HTMLInputElement

`Protected` onSelectedCallbackEvent

onSelectedCallbackEvent: OSOnSelectedEvent

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractMonthPicker.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 AbstractMonthPicker.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 AbstractMonthPicker.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 AbstractMonthPicker.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 IFlatpickrMonth.equalsToID

Inherited from AbstractMonthPicker.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 AbstractMonthPicker.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 AbstractMonthPicker.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 AbstractMonthPicker.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
Implementation of IFlatpickrMonth.setProviderEvent

Inherited from AbstractMonthPicker.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
Implementation of IFlatpickrMonth.unsetProviderEvent

Inherited from AbstractMonthPicker.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
Implementation of IFlatpickrMonth.updateProviderEvents

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

`Private` _getBodyOnClickGlobalEvent

_getBodyOnClickGlobalEvent(): void
Private
Method that will get the instance of the Global onBodyClick event.

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:42

`Private` _setAttributes

_setAttributes(): void
Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:50

`Private` _setCalendarCssClasses

_setCalendarCssClasses(): void
Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:71

`Private` _updateA11yProperties

_updateA11yProperties(): void
Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:110

`Protected` createProviderInstance

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:134

`Protected` onClose

onClose(): void
Protected
Method that will be triggered each time MonthPicker will be closed

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:189

`Protected` onMonthSelectedEvent

onMonthSelectedEvent(selectedMonthYear: Date[]): void
Protected
Method that will be triggered by library each month and year is selected

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Parameters
- selectedMonthYear: Date[]
Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:204

`Protected` onOpen

onOpen(): void
Protected
Method that will be triggered each time MonthPicker will open

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:248

`Protected` prepareConfigs

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Overrides AbstractMonthPicker.prepareConfigs
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:262

`Protected` setA11YProperties

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Overrides AbstractMonthPicker.setA11YProperties
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:275

`Protected` setCallbacks

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Overrides AbstractMonthPicker.setCallbacks
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:329

`Protected` setHtmlElements

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Overrides AbstractMonthPicker.setHtmlElements
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:339

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Overrides AbstractMonthPicker.unsetCallbacks
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:366

`Protected` unsetHtmlElements

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Overrides AbstractMonthPicker.unsetHtmlElements
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:381

`Protected` updatePlatformInputAttrs

updatePlatformInputAttrs(): void
Protected
Used to set needed properties to the platform input.

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:391

build

build(): void
Builds the Pattern

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Implementation of IFlatpickrMonth.build

Overrides AbstractMonthPicker.build
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:406

changeProperty

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
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 IFlatpickrMonth.changeProperty

Overrides AbstractMonthPicker.changeProperty
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:421

clear

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Implementation of IFlatpickrMonth.clear

Overrides AbstractMonthPicker.clear
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:453

close

close(): void
Method used to close MonthPicker

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Implementation of IFlatpickrMonth.close

Overrides AbstractMonthPicker.close
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:465

dispose

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Implementation of IFlatpickrMonth.dispose

Overrides AbstractMonthPicker.dispose
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:476

onRender

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Overrides AbstractMonthPicker.onRender
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:498

open

open(): void
Method used to open MonthPicker

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth

Returns void
Implementation of IFlatpickrMonth.open

Overrides AbstractMonthPicker.open
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:514

registerCallback

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IFlatpickrMonth.registerCallback

Overrides AbstractMonthPicker.registerCallback
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:526

setEditableInput

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Parameters
- isEditable: boolean
Returns void
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:543

setLanguage

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Parameters
- value: string
Returns void
Implementation of IFlatpickrMonth.setLanguage

Overrides AbstractMonthPicker.setLanguage
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:555

setProviderConfigs

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Parameters
- newConfigs: FlatpickrOptions
Returns void
Implementation of IFlatpickrMonth.setProviderConfigs

Overrides AbstractMonthPicker.setProviderConfigs
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:571

updateInitialMonth

updateInitialMonth(monthYear: MonthYear): void
Method used to update the InitialMonth config value

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Parameters
- monthYear: MonthYear
Returns void
Implementation of IFlatpickrMonth.updateInitialMonth

Overrides AbstractMonthPicker.updateInitialMonth
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:584

updatePrompt

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Parameters
- promptMessage: string
  
  The new prompt message value
Returns void
Overrides AbstractMonthPicker.updatePrompt
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:600

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.MonthPicker.AbstractMonthPicker._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 IFlatpickrMonth.selfElement

Inherited from OSFramework.OSUI.Patterns.MonthPicker.AbstractMonthPicker.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 IFlatpickrMonth.isBuilt

Inherited from OSFramework.OSUI.Patterns.MonthPicker.AbstractMonthPicker.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.MonthPicker.AbstractMonthPicker.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 IFlatpickrMonth.uniqueId

Inherited from OSFramework.OSUI.Patterns.MonthPicker.AbstractMonthPicker.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 IFlatpickrMonth.widgetId

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

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Implementation of IFlatpickrMonth.providerInfo

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

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Implementation of IFlatpickrMonth.provider

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

Constructors

constructor

new OSUIFlatpickrMonth(uniqueId: string, configs: JSON): OSUIFlatpickrMonth
Parameters
- uniqueId: string
- configs: JSON
Returns OSUIFlatpickrMonth
Overrides AbstractMonthPicker.constructor
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:27

Class OSUIFlatpickrMonth

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Protected providerEventsManagerInstance

Private _a11yInfoContainerElem

Private _bodyOnClickGlobalEvent

Private _bodyScrollCommonBehaviour

Private _flatpickrOpts

Private _isPlatformInputDisabled

Private _zindexCommonBehavior

Protected flatpickrInputElem

Protected monthPickerPlatformInputElem

Protected onSelectedCallbackEvent

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 _getBodyOnClickGlobalEvent

Memberof

Returns void

Private _setAttributes

Returns void

Private _setCalendarCssClasses

Returns void

`Protected` isProviderBased

`Protected` providerEventsManagerInstance

`Private` _a11yInfoContainerElem

`Private` _bodyOnClickGlobalEvent

`Private` _bodyScrollCommonBehaviour

`Private` _flatpickrOpts

`Private` _isPlatformInputDisabled

`Private` _zindexCommonBehavior

`Protected` flatpickrInputElem

`Protected` monthPickerPlatformInputElem

`Protected` onSelectedCallbackEvent

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` redraw

`Optional` saveEvent: boolean = true

`Private` _getBodyOnClickGlobalEvent

`Private` _setAttributes

`Private` _setCalendarCssClasses

`Private` _updateA11yProperties

`Protected` createProviderInstance

`Protected` onClose

`Protected` onMonthSelectedEvent

`Protected` onOpen

`Protected` prepareConfigs

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` updatePlatformInputAttrs