Class AbstractCarousel<P, C>`Abstract`

Defines the interface for OutSystemsUI Carousel Pattern

Type Parameters

P
C extends AbstractCarouselConfig

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

OSFramework.Patterns.AbstractProviderPattern<P, C>
- AbstractCarousel
  - OSUISplide

Implements

ICarousel

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/Pattern/AbstractPattern.ts:50

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 ICarousel.changeProperty

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

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

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

`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/Pattern/AbstractProviderPattern.ts:92

`Protected` triggerPlatformEventInitialized

triggerPlatformEventInitialized(platFormCallback: OSGeneric): void
Trigger platform's InstanceIntializedHandler client Action

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
Returns void
Inherited from AbstractProviderPattern.triggerPlatformEventInitialized
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:111

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/Pattern/AbstractProviderPattern.ts:137

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/Pattern/AbstractProviderPattern.ts:151

dispose

dispose(): void
Method to destroy created instance

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Implementation of ICarousel.dispose

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

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

Inherited from AbstractProviderPattern.setProviderEvent
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:181

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 ICarousel.unsetProviderEvent

Inherited from AbstractProviderPattern.unsetProviderEvent
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:214

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/Pattern/AbstractProviderPattern.ts:241

`Protected` `Abstract` prepareConfigs

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

`Abstract` registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Enables to register simple callbacks for the platform. Internal use.

Memberof
OSFramework.Interface.IProviderPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of ICarousel.registerCallback

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

`Abstract` setProviderConfigs

setProviderConfigs(providerConfigs: any): void
Method to enable extensibility to provider supported configs

Memberof
OSFramework.Interface.IProviderPattern
Parameters
- providerConfigs: any
Returns void
Implementation of ICarousel.setProviderConfigs

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

build

build(): void
Build object, instantiating dependencies, and manipulating DOM when necessary

Memberof
OSFramework.Interface.IBuilder

Returns void
Implementation of ICarousel.build

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

`Abstract` goTo

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

`Abstract` next

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

`Abstract` previous

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

`Abstract` setCarouselDirection

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

`Abstract` toggleDrag

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

`Abstract` toggleOnRender

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

`Abstract` updateOnRender

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

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/Pattern/AbstractPattern.ts:128

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of ICarousel.selfElement

Inherited from AbstractProviderPattern.selfElement
- Defined in OSFramework/Pattern/AbstractPattern.ts:139

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of ICarousel.isBuilt

Inherited from AbstractProviderPattern.isBuilt
- Defined in OSFramework/Pattern/AbstractPattern.ts:150

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractProviderPattern.configs
- Defined in OSFramework/Pattern/AbstractPattern.ts:161

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ICarousel.uniqueId

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

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ICarousel.widgetId

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

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

Properties

`Protected` _provider

_provider: P

`Protected` _providerInfo

_providerInfo: ProviderInfo

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

Constructors

constructor

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

Class AbstractCarousel<P, C>Abstract

Type Parameters

P

C extends AbstractCarouselConfig

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

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 unsetCallbacks

Returns void

Protected Abstract unsetHtmlElements

Returns void

Protected redraw

Memberof

Returns void

Protected triggerPlatformEventInitialized

Memberof

Parameters

platFormCallback: OSGeneric

Returns void

checkAddedProviderEvents

Memberof

Returns void

checkPendingProviderEvents

Memberof

Returns void

dispose

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

Protected Abstract prepareConfigs

Returns void

Abstract registerCallback

Memberof

Class AbstractCarousel<P, C>`Abstract`

`Protected` finishBuild

`Protected` `Abstract` setA11YProperties

`Protected` `Abstract` setCallbacks

`Protected` `Abstract` setHtmlElements

`Protected` `Abstract` unsetCallbacks

`Protected` `Abstract` unsetHtmlElements

`Protected` redraw

`Protected` triggerPlatformEventInitialized

`Optional` saveEvent: boolean = true

`Protected` `Abstract` prepareConfigs

`Abstract` registerCallback

`Abstract` setProviderConfigs

`Abstract` goTo

`Abstract` next

`Abstract` previous

`Abstract` setCarouselDirection

`Abstract` toggleDrag

`Abstract` toggleOnRender

`Abstract` updateOnRender

`Protected` _enableAccessibility

`Protected` _provider

`Protected` _providerInfo

`Protected` providerEventsManagerInstance