Class Gallery

Defines the interface for OutSystemsUI Gallery Pattern

Export

Implements

Hierarchy-Diagram

UML class diagram of Gallery

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for an interface in the UML class diagram

interface

icon for a public property in the UML class diagram

public property

icon for a protected property in the UML class diagram

protected property

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

icon for a protected method in the UML class diagram

protected method

icon for a private method in the UML class diagram

private method

italic abstract property/method

Hierarchy

AbstractPattern<GalleryConfig>
- Gallery

Implements

IGallery

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

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

dispose

dispose(): void
Disposes the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Implementation of IGallery.dispose

Inherited from AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:158

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

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

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Register a given callback event handler.

Abstract

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IGallery.registerCallback

Inherited from AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:184

`Private` _setItemsGap

_setItemsGap(): void
Private
Function used to set the Gallery's items gap

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:22

`Private` _setRowItemsDesktop

_setRowItemsDesktop(): void
Private
Function used to set the Gallery's number of items per row in Desktop

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:36

`Private` _setRowItemsPhone

_setRowItemsPhone(): void
Private
Function used to set the Gallery's number of items per row in Phone

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:65

`Private` _setRowItemsTablet

_setRowItemsTablet(): void
Private
Function used to set the Gallery's number of items per row in Tablet

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:93

`Protected` setA11YProperties

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

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:122

`Protected` setCallbacks

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

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:132

`Protected` setHtmlElements

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

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:142

`Protected` unsetCallbacks

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

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:152

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:162

build

build(): void
Method to build the Gallery

Memberof
OSFramework.Patterns.Gallery.Gallery

Returns void
Implementation of IGallery.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:171

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to change the value of configs/current state.

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

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:192

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractPattern._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 IGallery.selfElement

Inherited from AbstractPattern.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 IGallery.isBuilt

Inherited from AbstractPattern.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 AbstractPattern.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 IGallery.uniqueId

Inherited from AbstractPattern.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 IGallery.widgetId

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

Constructors

constructor

new Gallery(uniqueId: string, configs: JSON): OSFramework.OSUI.Patterns.Gallery.Gallery
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.Gallery.Gallery
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Gallery/Gallery.ts:12