Class AbstractCarousel<P, C>`Abstract`

Defines the interface for OutSystemsUI Carousel Pattern

Constructors

constructor

new AbstractCarousel<P, C extends AbstractCarouselConfig>(
uniqueId: string,
configs: C,
): AbstractCarousel<P, C>
Type Parameters
- P
- C extends AbstractCarouselConfig
Parameters
- uniqueId: string
- configs: C
Returns AbstractCarousel<P, C>
Overrides AbstractProviderPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:7

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractProviderPattern._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 ICarousel.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.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ICarousel.isBuilt

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

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ICarousel.widgetId

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

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Returns ProviderInfo

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

provider

get provider(): P
Provider getter

Returns P

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

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

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ICarousel.equalsToID

Inherited from AbstractProviderPattern.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Protected` `Abstract`setA11YProperties

setA11YProperties(): void
Returns void
Inherited from AbstractProviderPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:267

`Protected` `Abstract`setCallbacks

setCallbacks(): void
Returns void
Inherited from AbstractProviderPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:268

`Protected` `Abstract`setHtmlElements

setHtmlElements(): void
Returns void
Inherited from AbstractProviderPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:269

`Protected` `Abstract`unsetHtmlElements

unsetHtmlElements(): void
Returns void
Inherited from AbstractProviderPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:271

`Protected`redraw

redraw(): void
Protected
Method that will be responsible to redraw pattern when needed

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractProviderPattern.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:132

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractProviderPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:149

checkAddedProviderEvents

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

Returns void

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractProviderPattern.checkPendingProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:195

dispose

dispose(): void
Method to destroy created instance

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of ICarousel.dispose

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

`Abstract`registerCallback

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

Memberof
AbstractProviderPattern
Implementation of ICarousel.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.
Parameters
- providerConfigs: unknown
Returns void

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

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

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

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

build

build(): void
Method to build the pattern

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of ICarousel.build

Overrides AbstractProviderPattern.build
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:11

`Abstract`goTo

goTo(index: number): void
Parameters
- index: number
Returns void
Implementation of ICarousel.goTo
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:16

`Abstract`next

next(): void
Returns void
Implementation of ICarousel.next
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:17

`Abstract`previous

previous(): void
Returns void
Implementation of ICarousel.previous
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:18

`Abstract`setCarouselDirection

setCarouselDirection(direction: string): void
Parameters
- direction: string
Returns void
Implementation of ICarousel.setCarouselDirection
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:19

`Abstract`toggleDrag

toggleDrag(hasDrag: boolean): void
Parameters
- hasDrag: boolean
Returns void
Implementation of ICarousel.toggleDrag
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:20

`Abstract`toggleOnRender

toggleOnRender(blockOnRender: boolean): void
Parameters
- blockOnRender: boolean
Returns void
Implementation of ICarousel.toggleOnRender
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:21

`Abstract`updateOnRender

updateOnRender(): void
Returns void
Implementation of ICarousel.updateOnRender
- Defined in OSFramework/OSUI/Pattern/Carousel/AbstractCarousel.ts:22

Class AbstractCarousel<P, C>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractCarousel<P, C>

Properties

ProtectedisProviderBased

ProtectedproviderEventsManagerInstance

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

changeProperty

Parameters

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

Protected AbstractsetA11YProperties

Returns void

Protected AbstractsetCallbacks

Returns void

Protected AbstractsetHtmlElements

Returns void

Protected AbstractunsetHtmlElements

Returns void

Protectedredraw

Returns void

Memberof

ProtectedunsetCallbacks

Returns void

Memberof

checkAddedProviderEvents

Returns void

Class AbstractCarousel<P, C>`Abstract`

`Protected`isProviderBased

`Protected`providerEventsManagerInstance

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected` `Abstract`setA11YProperties

`Protected` `Abstract`setCallbacks

`Protected` `Abstract`setHtmlElements

`Protected` `Abstract`unsetHtmlElements

`Protected`redraw

`Protected`unsetCallbacks

`Abstract`registerCallback

`Protected` `Abstract`prepareConfigs

`Abstract`goTo

`Abstract`next

`Abstract`previous

`Abstract`setCarouselDirection

`Abstract`toggleDrag

`Abstract`toggleOnRender

`Abstract`updateOnRender