Class FlipContent

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<FlipContentConfig>
- FlipContent

Implements

IFlipContent

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

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

`Private` _keydownCallback

_keydownCallback(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:22

`Private` _removeEvents

_removeEvents(): void
Returns void
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:36

`Private` _setEventHandlers

_setEventHandlers(): void
Returns void
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:42

`Private` _setStartsFlipped

_setStartsFlipped(): void
Returns void
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:57

`Private` _toggleClasses

_toggleClasses(): void
Returns void
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:64

`Private` _triggerPlatformEvent

_triggerPlatformEvent(): void
Returns void
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:73

`Private` _updateA11yProperties

_updateA11yProperties(): void
Returns void
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:80

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Set the A11Y attributes

Memberof
OSFramework.Patterns.FlipContent.FlipContent

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

`Protected` setCallbacks

setCallbacks(): void
Protected
Set the events

Memberof
OSFramework.Patterns.FlipContent.FlipContent

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

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Set the HTML elements

Memberof
OSFramework.Patterns.FlipContent.FlipContent

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

`Protected` unsetCallbacks

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

Memberof
OSFramework.Patterns.FlipContent.FlipContent

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

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Set the HTML elements

Memberof
OSFramework.Patterns.FlipContent.FlipContent

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

build

build(): void
Building Flip Content

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Implementation of IFlipContent.build

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

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
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/Pattern/FlipContent/FlipContent.ts:179

dispose

dispose(): void
Destroy FlipContent

Memberof
OSFramework.Patterns.FlipContent.FlipContent

Returns void
Implementation of IFlipContent.dispose

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

registerCallback

registerCallback(callback: OSFlipEvent): void
Register OnToogleClick clientAction as a callBack reference

Memberof
OSFramework.Patterns.FlipContent.FlipContent
Parameters
- callback: OSFlipEvent
Returns void
Implementation of IFlipContent.registerCallback
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:212

showBackContent

showBackContent(): void
Returns void
Implementation of IFlipContent.showBackContent
- Defined in OSFramework/Pattern/FlipContent/FlipContent.ts:218

showFrontContent

showFrontContent(): void
Tries to show the font

Memberof
OSFramework.Patterns.FlipContent.FlipContent

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

toggleFlipContent

toggleFlipContent(): void
Public 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/Pattern/FlipContent/FlipContent.ts:240

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

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/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 IFlipContent.isBuilt

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

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

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

Properties

`Private` _eventClick

_eventClick: Generic

`Private` _eventKeydown

_eventKeydown: Generic

`Private` _flipWrapperElement

_flipWrapperElement: HTMLElement

`Private` _plataformEventFlip

_plataformEventFlip: OSFlipEvent

Constructors

constructor

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

Class FlipContent

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _keydownCallback

Parameters

e: KeyboardEvent

Returns void

Private _removeEvents

Returns void

Private _setEventHandlers

Returns void

Private _setStartsFlipped

Returns void

Private _toggleClasses

Returns void

Private _triggerPlatformEvent

Returns void

Private _updateA11yProperties

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

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

dispose

Memberof

Returns void

registerCallback

Memberof

Parameters

callback: OSFlipEvent

Returns void

showBackContent

Returns void

showFrontContent

Memberof

Returns void

toggleFlipContent

Memberof

Returns void

Accessors

Protected _enableAccessibility

Memberof

Returns boolean

`Protected` finishBuild

`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

`Private` _eventClick

`Private` _eventKeydown

`Private` _flipWrapperElement

`Private` _plataformEventFlip