Class FlipContent

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<FlipContentConfig>
- FlipContent

Implements

IFlipContent

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _eventClick

_eventClick: Generic

`Private` _eventKeydown

_eventKeydown: Generic

`Private` _flipWrapperElement

_flipWrapperElement: HTMLElement

`Private` _platformEventOnToggle

_platformEventOnToggle: OSGeneric

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

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

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

`Private` _keydownCallback

_keydownCallback(e: KeyboardEvent): void
Private
Method to toggle pattern on keypress

Memberof
FlipContent
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:28

`Private` _removeEvents

_removeEvents(): void
Private
Method to remove the event listeners

Memberof
FlipContent

Returns void
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:47

`Private` _setEventHandlers

_setEventHandlers(): void
Private
Method to set the handlers and the classes for when the FlipSelf is active or not

Memberof
FlipContent

Returns void
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:58

`Private` _setStartsFlipped

_setStartsFlipped(): void
Private
Method to toggle FlipContent, if is to start flipped

Memberof
FlipContent

Returns void
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:78

`Private` _toggleClasses

_toggleClasses(): void
Private
Method to set the classes on the pattern's first render, toggle click & parameters changed

Memberof
FlipContent

Returns void
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:90

`Private` _triggerPlatformEvent

_triggerPlatformEvent(): void
Private
Method to trigger the toggle event on the platform

Memberof
FlipContent

Returns void
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:104

`Private` _updateA11yProperties

_updateA11yProperties(): void
Private
Method to update the A11Y attributes

Memberof
FlipContent

Returns void
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:114

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Method to set the A11Y attributes

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:130

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to set the events

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:147

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to set the HTML elements

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:160

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to remove all assigned callbacks

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:170

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to set the HTML elements

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:183

build

build(): void
Method to build the Flip Content

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Implementation of IFlipContent.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:192

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to update value when a parameters changed occurs

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

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:215

dispose

dispose(): void
Method to destroy FlipContent

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Implementation of IFlipContent.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:236

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method to register a given callback event handler.

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

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:250

showBackContent

showBackContent(): void
Method to show the back content

Memberof
FlipContent

Returns void
Implementation of IFlipContent.showBackContent
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:267

showFrontContent

showFrontContent(): void
Method to show the front content

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Implementation of IFlipContent.showFrontContent
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:278

toggleFlipContent

toggleFlipContent(): void
Method to trigger the flipping of the pattern and the event on the platform's side

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Implementation of IFlipContent.toggleFlipContent
- Defined in OSFramework/OSUI/Pattern/FlipContent/FlipContent.ts:289

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 IFlipContent.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 IFlipContent.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 IFlipContent.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 IFlipContent.widgetId

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

Constructors

constructor

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

Class FlipContent

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _eventClick

Private _eventKeydown

Private _flipWrapperElement

Private _platformEventOnToggle

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

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _keydownCallback

Memberof

Parameters

e: KeyboardEvent

Returns void

Private _removeEvents

Memberof

Returns void

Private _setEventHandlers

Memberof

Returns void

Private _setStartsFlipped

Memberof

Returns void

Private _toggleClasses

Memberof

Returns void

Private _triggerPlatformEvent

Memberof

Returns void

Private _updateA11yProperties

Memberof

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

build

Memberof

Returns void

changeProperty

`Protected` isProviderBased

`Private` _eventClick

`Private` _eventKeydown

`Private` _flipWrapperElement

`Private` _platformEventOnToggle

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _keydownCallback

`Private` _removeEvents

`Private` _setEventHandlers

`Private` _setStartsFlipped

`Private` _toggleClasses

`Private` _triggerPlatformEvent

`Private` _updateA11yProperties

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility