Class AbstractMonthPicker<P, C>`Abstract`

Defines the interface for OutSystemsUI MonthPicker Pattern

Export

Interface

IMonthPicker

Type Parameters

P
C extends AbstractMonthPickerConfig

Hierarchy-Diagram

UML class diagram of AbstractMonthPicker

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

OSFramework.OSUI.Patterns.AbstractProviderPattern<P, C>
- AbstractMonthPicker
  - OSUIFlatpickrMonth

Implements

IMonthPicker

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractProviderPattern.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 AbstractProviderPattern.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 AbstractProviderPattern.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 AbstractProviderPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Changes the value of the properties in the configurations and if changes are to a common property, applies the changes.

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of IMonthPicker.changeProperty

Inherited from AbstractProviderPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:128

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 IMonthPicker.equalsToID

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

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractProviderPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:149

build

build(): void
Method to build the pattern

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Implementation of IMonthPicker.build

Inherited from AbstractProviderPattern.build
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:158

checkAddedProviderEvents

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

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

dispose

dispose(): void
Method to destroy created instance

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Implementation of IMonthPicker.dispose

Inherited from AbstractProviderPattern.dispose
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:210

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Register the default events for provider based patterns.

Abstract

Memberof
AbstractProviderPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IMonthPicker.registerCallback

Inherited from AbstractProviderPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:229

setProviderConfigs

setProviderConfigs(providerConfigs: unknown): void
Method used to set all the provider configs. In the AbstractProviderPattern, it will simply trigger the callback to warn that the configs have been applied to the provider.

Memberof
AbstractProviderPattern
Parameters
- providerConfigs: unknown
Returns void
Implementation of IMonthPicker.setProviderConfigs

Inherited from AbstractProviderPattern.setProviderConfigs
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:248

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 IMonthPicker.setProviderEvent

Inherited from AbstractProviderPattern.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 IMonthPicker.unsetProviderEvent

Inherited from AbstractProviderPattern.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 AbstractProviderPattern.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:322

`Protected` `Abstract` prepareConfigs

prepareConfigs(): void
Returns void
Inherited from AbstractProviderPattern.prepareConfigs
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:379

`Abstract` clear

clear(): void
Returns void
Implementation of IMonthPicker.clear
- Defined in OSFramework/OSUI/Pattern/MonthPicker/AbstractMonthPicker.ts:13

`Abstract` close

close(): void
Method signature to close the pattern.

Memberof
OSFramework.Interface.IOpenable

Returns void
Implementation of IMonthPicker.close
- Defined in OSFramework/OSUI/Pattern/MonthPicker/AbstractMonthPicker.ts:14

`Abstract` onRender

onRender(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/MonthPicker/AbstractMonthPicker.ts:15

`Abstract` open

open(): void
Method signature to open the pattern.

Memberof
IOpenable

Returns void
Implementation of IMonthPicker.open
- Defined in OSFramework/OSUI/Pattern/MonthPicker/AbstractMonthPicker.ts:16

`Abstract` setLanguage

setLanguage(value: string): void
Parameters
- value: string
Returns void
Implementation of IMonthPicker.setLanguage
- Defined in OSFramework/OSUI/Pattern/MonthPicker/AbstractMonthPicker.ts:17

`Abstract` updateInitialMonth

updateInitialMonth(monthYear: MonthYear): void
Parameters
- monthYear: MonthYear
Returns void
Implementation of IMonthPicker.updateInitialMonth
- Defined in OSFramework/OSUI/Pattern/MonthPicker/AbstractMonthPicker.ts:18

`Abstract` updatePrompt

updatePrompt(promptMessage: string): void
Parameters
- promptMessage: string
Returns void
- Defined in OSFramework/OSUI/Pattern/MonthPicker/AbstractMonthPicker.ts:19

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractProviderPattern._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 IMonthPicker.selfElement

Inherited from AbstractProviderPattern.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 IMonthPicker.isBuilt

Inherited from AbstractProviderPattern.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 AbstractProviderPattern.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 IMonthPicker.uniqueId

Inherited from AbstractProviderPattern.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 IMonthPicker.widgetId

Inherited from AbstractProviderPattern.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

Constructors

constructor

new AbstractMonthPicker<P, C>(uniqueId: string, configs: C): AbstractMonthPicker<P, C>
Type Parameters
- P
- C extends AbstractMonthPickerConfig<C>
Parameters
- uniqueId: string
- configs: C
Returns AbstractMonthPicker<P, C>
Overrides AbstractProviderPattern.constructor
- Defined in OSFramework/OSUI/Pattern/MonthPicker/AbstractMonthPicker.ts:8

Class AbstractMonthPicker<P, C>Abstract

Export

Interface

Type Parameters

P

C extends AbstractMonthPickerConfig

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Protected providerEventsManagerInstance

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

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected Abstract setA11YProperties

Returns void

Protected Abstract setCallbacks

Returns void

Protected Abstract setHtmlElements

Returns void

Protected Abstract unsetHtmlElements

Returns void

Protected redraw

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

build

Memberof

Returns void

checkAddedProviderEvents

Memberof

Returns void

checkPendingProviderEvents

Memberof

Returns void

dispose

Memberof

Returns void

registerCallback

Abstract

Memberof

Parameters

eventName: string

callback: OSGeneric

Returns void

setProviderConfigs

Class AbstractMonthPicker<P, C>`Abstract`

`Protected` isProviderBased

`Protected` providerEventsManagerInstance

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` `Abstract` setA11YProperties

`Protected` `Abstract` setCallbacks

`Protected` `Abstract` setHtmlElements

`Protected` `Abstract` unsetHtmlElements

`Protected` redraw

`Protected` unsetCallbacks

`Optional` saveEvent: boolean = true

`Protected` `Abstract` prepareConfigs

`Abstract` clear

`Abstract` close

`Abstract` onRender

`Abstract` open

`Abstract` setLanguage

`Abstract` updateInitialMonth

`Abstract` updatePrompt

`Protected` _enableAccessibility