Class OSUIFlatpickrMonth

Defines the interface for MonthPicker Pattern Based on Flatpickr provider

Hierarchy (View Summary)

AbstractMonthPicker<Flatpickr, FlatpickrMonthConfig>
- OSUIFlatpickrMonth

Implements

IFlatpickrMonth

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:35

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Protected`flatpickrInputElem

flatpickrInputElem: HTMLInputElement

`Protected`monthPickerPlatformInputElem

monthPickerPlatformInputElem: HTMLInputElement

`Protected`onSelectedCallbackEvent

onSelectedCallbackEvent: OSOnSelectedEvent

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

Returns boolean

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

Returns C

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

Returns string

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

Returns string

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

Returns ProviderInfo

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

Returns P

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickrMonth.provider

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

Returns void

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

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractMonthPicker.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 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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
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
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- OptionalsaveEvent: boolean = true
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
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
Parameters
- eventId: string
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
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
Parameters
- providerInfo: ProviderInfo
Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickrMonth.updateProviderEvents

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

`Protected`createProviderInstance

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:170

`Protected`onClose

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:227

`Protected`onMonthSelectedEvent

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:242

`Protected`onOpen

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:286

`Protected`prepareConfigs

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Overrides AbstractMonthPicker.prepareConfigs
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:300

`Protected`setA11YProperties

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Overrides AbstractMonthPicker.setA11YProperties
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:313

`Protected`setCallbacks

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Overrides AbstractMonthPicker.setCallbacks
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:398

`Protected`setHtmlElements

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Overrides AbstractMonthPicker.setHtmlElements
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:408

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Overrides AbstractMonthPicker.unsetCallbacks
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:435

`Protected`unsetHtmlElements

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Overrides AbstractMonthPicker.unsetHtmlElements
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:450

`Protected`updatePlatformInputAttrs

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:460

build

build(): void
Builds the Pattern

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.build

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

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.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.changeProperty

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

clear

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.clear

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

close

close(): void
Method used to close MonthPicker

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.close

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

dispose

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.dispose

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

onRender

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

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Overrides AbstractMonthPicker.onRender
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:567

open

open(): void
Method used to open MonthPicker

Returns void

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.open

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

registerCallback

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.registerCallback

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

setEditableInput

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:612

setLanguage

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.setLanguage

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

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.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.setProviderConfigs

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

updateInitialMonth

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

Memberof
Providers.OSUI.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Implementation of IFlatpickrMonth.updateInitialMonth

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

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.MonthPicker.Flatpickr.OSUIFlatpickrMonth
Overrides AbstractMonthPicker.updatePrompt
- Defined in Providers/OSUI/Monthpicker/Flatpickr/FlatpickrMonth.ts:669

Class OSUIFlatpickrMonth

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSUIFlatpickrMonth

Properties

ProtectedisProviderBased

ProtectedproviderEventsManagerInstance

ProtectedflatpickrInputElem

ProtectedmonthPickerPlatformInputElem

ProtectedonSelectedCallbackEvent

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

Returns void

Memberof

updateProviderEvents

Parameters

`Protected`isProviderBased

`Protected`providerEventsManagerInstance

`Protected`flatpickrInputElem

`Protected`monthPickerPlatformInputElem

`Protected`onSelectedCallbackEvent

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`redraw

`Protected`createProviderInstance

`Protected`onClose

`Protected`onMonthSelectedEvent

`Protected`onOpen

`Protected`prepareConfigs

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Protected`updatePlatformInputAttrs