Class OSUIFlatpickrTime

Defines the interface for Timepicker Pattern Based on Flatpickr provider

Hierarchy (View Summary)

AbstractTimePicker<Flatpickr, FlatpickrTimeConfig>
- OSUIFlatpickrTime

Implements

IFlatpickrTime

Index

Constructors

constructor

new OSUIFlatpickrTime(uniqueId: string, configs: JSON): OSUIFlatpickrTime
Parameters
- uniqueId: string
- configs: JSON
Returns OSUIFlatpickrTime
Overrides AbstractTimePicker.constructor
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:25

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Protected`flatpickrInputElem

flatpickrInputElem: HTMLInputElement

`Protected`onChangeCallbackEvent

onChangeCallbackEvent: OSFramework.OSUI.Patterns.TimePicker.Callbacks.OSOnChangeEvent

`Protected`timePickerPlatformInputElem

timePickerPlatformInputElem: HTMLInputElement

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.TimePicker.AbstractTimePicker._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 IFlatpickrTime.selfElement

Inherited from OSFramework.OSUI.Patterns.TimePicker.AbstractTimePicker.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 IFlatpickrTime.isBuilt

Inherited from OSFramework.OSUI.Patterns.TimePicker.AbstractTimePicker.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.TimePicker.AbstractTimePicker.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 IFlatpickrTime.uniqueId

Inherited from OSFramework.OSUI.Patterns.TimePicker.AbstractTimePicker.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 IFlatpickrTime.widgetId

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

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Returns ProviderInfo

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickrTime.providerInfo

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

provider

get provider(): P
Provider getter

Returns P

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickrTime.provider

Inherited from OSFramework.OSUI.Patterns.TimePicker.AbstractTimePicker.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 AbstractTimePicker.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 AbstractTimePicker.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 AbstractTimePicker.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 AbstractTimePicker.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 IFlatpickrTime.equalsToID

Inherited from AbstractTimePicker.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 AbstractTimePicker.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 AbstractTimePicker.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 AbstractTimePicker.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 IFlatpickrTime.setProviderEvent

Inherited from AbstractTimePicker.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 IFlatpickrTime.unsetProviderEvent

Inherited from AbstractTimePicker.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 IFlatpickrTime.updateProviderEvents

Inherited from AbstractTimePicker.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.TimePicker.Flatpickr.OSUIFlatpickrTime
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:150

`Protected`onClose

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:208

`Protected`onOpen

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:222

`Protected`onTimeSelectedEvent

onTimeSelectedEvent(selectedTime: Date[]): void
Parameters
- selectedTime: Date[]
Returns void
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:231

`Protected`prepareConfigs

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Overrides AbstractTimePicker.prepareConfigs
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:249

`Protected`setA11YProperties

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Overrides AbstractTimePicker.setA11YProperties
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:262

`Protected`setCallbacks

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Overrides AbstractTimePicker.setCallbacks
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:289

`Protected`setHtmlElements

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Overrides AbstractTimePicker.setHtmlElements
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:299

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Overrides AbstractTimePicker.unsetCallbacks
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:320

`Protected`unsetHtmlElements

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Overrides AbstractTimePicker.unsetHtmlElements
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:335

`Protected`updatePlatformInputAttrs

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:345

build

build(): void
Method to build the pattern

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of IFlatpickrTime.build

Overrides AbstractTimePicker.build
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:355

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.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.changeProperty

Overrides AbstractTimePicker.changeProperty
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:370

clear

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.clear

Overrides AbstractTimePicker.clear
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:403

close

close(): void
Method used to close TimePicker

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.close

Overrides AbstractTimePicker.close
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:415

dispose

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.dispose

Overrides AbstractTimePicker.dispose
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:426

onRender

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

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.onRender

Overrides AbstractTimePicker.onRender
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:448

open

open(): void
Method used to open TimePicker

Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.open

Overrides AbstractTimePicker.open
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:464

registerCallback

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

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.registerCallback

Overrides AbstractTimePicker.registerCallback
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:476

setEditableInput

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

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:492

setLanguage

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

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.setLanguage

Overrides AbstractTimePicker.setLanguage
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:504

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.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.setProviderConfigs

Overrides AbstractTimePicker.setProviderConfigs
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:520

toggleNativeBehavior

toggleNativeBehavior(isNative: boolean): void
Method used to toggle the default native behavior of TimePicker
Parameters
- isNative: boolean
Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:533

updateInitialTime

updateInitialTime(value: string): void
Method used to update the InitialTime config value
Parameters
- value: string
  The new InitialTime value that will be set
Returns void

Memberof
Providers.OSUI.TimePicker.Flatpickr.OSUIFlatpickrTime
Implementation of IFlatpickrTime.updateInitialTime

Overrides AbstractTimePicker.updateInitialTime
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:547

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.TimePicker.Flatpickr.OSUIFlatpickrTime
Overrides AbstractTimePicker.updatePrompt
- Defined in Providers/OSUI/Timepicker/Flatpickr/FlatpickrTime.ts:562

Class OSUIFlatpickrTime

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSUIFlatpickrTime

Properties

ProtectedisProviderBased

ProtectedproviderEventsManagerInstance

ProtectedflatpickrInputElem

ProtectedonChangeCallbackEvent

ProtectedtimePickerPlatformInputElem

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`onChangeCallbackEvent

`Protected`timePickerPlatformInputElem

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`redraw

`Protected`createProviderInstance

`Protected`onClose

`Protected`onOpen

`Protected`onTimeSelectedEvent

`Protected`prepareConfigs

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Protected`updatePlatformInputAttrs