Class TabsContentItem

Defines the interface for OutSystemsUI Patterns

Export

Implements

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

private property

public method

protected method

italic abstract property/method

Hierarchy

OSFramework.Patterns.AbstractChild<TabsContentItemConfig, ITabs>
- TabsContentItem

Implements

ITabsContentItem

Methods

`Protected` notifyParent

notifyParent(actionType: string): void
Method used to notify parent about the action that was performed

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- actionType: string
  
  Action Type name (Should be based on an Enum)
Returns void
Inherited from AbstractChild.notifyParent
- Defined in OSFramework/Pattern/AbstractChild.ts:36

`Protected` setParentInfo

setParentInfo(parentSelector: string, getPatternByIdAPI: Function, canBeOrphan?: boolean): void
Protected
Method that will Get and Set parent element info.

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- parentSelector: string
  
  Selector to find for parent Element
- getPatternByIdAPI: Function
  
  API reference method from Parent Pattern that will return the PatternById
- Optional canBeOrphan: boolean
  
  option for patterns that can work without a parent
Returns void
Inherited from AbstractChild.setParentInfo
- Defined in OSFramework/Pattern/AbstractChild.ts:50

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractChild.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 ITabsContentItem.changeProperty

Inherited from AbstractChild.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 ITabsContentItem.equalsToID

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

`Protected` setA11YProperties

setA11YProperties(isUpdate??: boolean): void
Protected
Method to handle the Accessibility attributes

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem
Parameters
- Optional isUpdate: boolean = true
Returns void
Overrides AbstractChild.setA11YProperties
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:29

`Protected` setCallbacks

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

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns void
Overrides AbstractChild.setCallbacks
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:52

`Protected` setHtmlElements

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

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns void
Overrides AbstractChild.setHtmlElements
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:62

`Protected` unsetCallbacks

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

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns void
Overrides AbstractChild.unsetCallbacks
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:72

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to unset the HTML Elements

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns void
Overrides AbstractChild.unsetHtmlElements
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:82

build

build(): void
Method to build the pattern

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns void
Implementation of ITabsContentItem.build

Overrides AbstractChild.build
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:91

dispose

dispose(): void
Method to remove event listener and destroy TabsContentItem instance

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns void
Implementation of ITabsContentItem.dispose

Overrides AbstractChild.dispose
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:114

getDataTab

getDataTab(): number
Method to get the current data-tab attribute, called by the Tabs

Returns
{number}

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns number
Implementation of ITabsContentItem.getDataTab
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:128

getOffsetLeft

getOffsetLeft(): number
Method to get the element offsetLeft value, called by the Tabs

Returns
{number}

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns number
Implementation of ITabsContentItem.getOffsetLeft
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:138

setAriaLabelledByAttribute

setAriaLabelledByAttribute(headerItemId: string): void
Method to set the aria-labbeledby attribute, called by the tabs

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem
Parameters
- headerItemId: string
Returns void
Implementation of ITabsContentItem.setAriaLabelledByAttribute
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:148

setDataTab

setDataTab(dataTab: number): void
Method to set the data-tab attribute, called by the tabs

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem
Parameters
- dataTab: number
Returns void
Implementation of ITabsContentItem.setDataTab
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:158

setIsActive

setIsActive(): void
Method to set the element as active, called by the tabs

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns void
Implementation of ITabsContentItem.setIsActive
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:168

setOnDragObserver

setOnDragObserver(observer: IntersectionObserver): void
Method to set the intersection observer, called by the tabs

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem
Parameters
- observer: IntersectionObserver
Returns void
Implementation of ITabsContentItem.setOnDragObserver
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:182

unobserveDragObserver

unobserveDragObserver(observer: IntersectionObserver): void
Method to stop observing this element in the intersection observer, called by the tabs

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem
Parameters
- observer: IntersectionObserver
Returns void
Implementation of ITabsContentItem.unobserveDragObserver
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:192

unsetIsActive

unsetIsActive(): void
Method to set the element as active, called by the tabs

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns void
Implementation of ITabsContentItem.unsetIsActive
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:202

Accessors

isFirstChild

get isFirstChild(): boolean
Getter that allows to check if it's the first child.

Memberof
OSFramework.Patterns.AbstractChild

Returns boolean
Implementation of ITabsContentItem.isFirstChild

Inherited from AbstractChild.isFirstChild
- Defined in OSFramework/Pattern/AbstractChild.ts:77

isLastChild

get isLastChild(): boolean
Getter that allows to check if it's the last child.

Memberof
OSFramework.Patterns.AbstractChild

Returns boolean
Implementation of ITabsContentItem.isLastChild

Inherited from AbstractChild.isLastChild
- Defined in OSFramework/Pattern/AbstractChild.ts:97
set isLastChild(value: boolean): void
Setter that allows to define it's the last child.

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- value: boolean
Returns void
Implementation of ITabsContentItem.isLastChild

Inherited from AbstractChild.isLastChild
- Defined in OSFramework/Pattern/AbstractChild.ts:106

parentId

get parentId(): string
Getter that allows to obtain the parentId.

Memberof
OSFramework.Patterns.AbstractChild

Returns string
Inherited from AbstractChild.parentId
- Defined in OSFramework/Pattern/AbstractChild.ts:117

parentObject

get parentObject(): PT
Getter that allows to obtain the parent reference.

Memberof
OSFramework.Patterns.AbstractChild

Returns PT
Inherited from AbstractChild.parentObject
- Defined in OSFramework/Pattern/AbstractChild.ts:128

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractChild._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 ITabsContentItem.selfElement

Inherited from AbstractChild.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 ITabsContentItem.isBuilt

Inherited from AbstractChild.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 AbstractChild.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 ITabsContentItem.uniqueId

Inherited from AbstractChild.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 ITabsContentItem.widgetId

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

IsActive

get IsActive(): boolean
Readable property to get the active state of the element

Memberof
OSFramework.Patterns.TabsContentItem.TabsContentItem

Returns boolean
Implementation of ITabsContentItem.IsActive
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:217

Properties

`Private` _dataTab

_dataTab: number

`Private` _focusableElements

_focusableElements: HTMLElement[]

`Private` _isActive

_isActive: boolean

Constructors

constructor

new TabsContentItem(uniqueId: string, configs: JSON): OSFramework.Patterns.TabsContentItem.TabsContentItem
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.Patterns.TabsContentItem.TabsContentItem
Overrides AbstractChild.constructor
- Defined in OSFramework/Pattern/TabsContentItem/TabsContentItem.ts:18

Class TabsContentItem

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected notifyParent

Memberof

Parameters

actionType: string

Returns void

Protected setParentInfo

Memberof

Parameters

parentSelector: string

getPatternByIdAPI: Function

Optional canBeOrphan: boolean

Returns void

Protected finishBuild

Memberof

Returns void

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected setA11YProperties

Memberof

Parameters

Optional isUpdate: boolean = true

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

dispose

Memberof

Returns void

getDataTab

Returns

Memberof

Returns number

getOffsetLeft

Returns

Memberof

Returns number

setAriaLabelledByAttribute

Memberof

Parameters

headerItemId: string

Returns void

setDataTab

Memberof

Parameters

dataTab: number

`Protected` notifyParent

`Protected` setParentInfo

`Optional` canBeOrphan: boolean

`Protected` finishBuild

`Protected` setA11YProperties

`Optional` isUpdate: boolean = true

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility

`Private` _dataTab

`Private` _focusableElements

`Private` _isActive