Class Tabs

Defines the interface for OutSystemsUI Patterns

Export

Implements

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.OSUI.Patterns.AbstractParent<TabsConfig, ITabsContentItem | ITabsHeaderItem>
- Tabs

Implements

ITabs

Index

Methods

`Protected` getChild

getChild(childId: string): ITabsHeaderItem | ITabsContentItem
Protected
Get the child reference based on given Id

Returns
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Child Id of the element to be found
Returns ITabsHeaderItem | ITabsContentItem
Inherited from AbstractParent.getChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:32

`Protected` getChildByIndex

getChildByIndex(index: number, childType?: string): ITabsHeaderItem | ITabsContentItem
Protected
Get a child reference by a given Index position

Returns
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- index: number
  
  Index of the item to be returned
- Optional childType: string
  
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns ITabsHeaderItem | ITabsContentItem
Inherited from AbstractParent.getChildByIndex
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:53

`Protected` getChildIndex

getChildIndex(childId: string): number
Protected
Get a child index from a given child Id

Returns
Index value

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Child id where index will be found
Returns number
Inherited from AbstractParent.getChildIndex
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:72

`Protected` setChild

setChild(childItem: ITabsHeaderItem | ITabsContentItem): void
Protected
Method that is used to set a given child as a Parent child.

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childItem: ITabsHeaderItem | ITabsContentItem
  
  Reference to be added
Returns void
Inherited from AbstractParent.setChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:89

`Protected` unsetChild

unsetChild(childId: string): void
Protected
Method that will remove Child by given Id

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Id of the item that will be removed
Returns void
Inherited from AbstractParent.unsetChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:121

getChildItems

getChildItems(type?: string): (ITabsHeaderItem | ITabsContentItem)[]
Getter that allows to obtain all the childs when parent only contains childs of one type, otherwise a type must be passed in order to return all child of the given type!

Returns

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- Optional type: string
  
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns (ITabsHeaderItem | ITabsContentItem)[]
Inherited from AbstractParent.getChildItems
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:186

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractParent.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 AbstractParent.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 AbstractParent.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 AbstractParent.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 ITabs.equalsToID

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

`Private` _addContentItem

_addContentItem(tabsContentChildItem: OSFramework.OSUI.Patterns.TabsContentItem.TabsContentItem): void
Private
Method that it's called whenever a new TabsContentItem is rendered

Memberof
Tabs
Parameters
- tabsContentChildItem: OSFramework.OSUI.Patterns.TabsContentItem.TabsContentItem
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:63

`Private` _addEvents

_addEvents(): void
Private
Add event listener for arrow navigation

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:100

`Private` _addHeaderItem

_addHeaderItem(tabsHeaderChildItem: OSFramework.OSUI.Patterns.TabsHeaderItem.TabsHeaderItem): void
Private
Method that it's called whenever a new TabsHeaderItem is rendered

Memberof
Tabs
Parameters
- tabsHeaderChildItem: OSFramework.OSUI.Patterns.TabsHeaderItem.TabsHeaderItem
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:125

`Private` _changeActiveContentItem

_changeActiveContentItem(newTabIndex: number, triggeredByObserver: boolean): void
Private
Method to change the active content item

Memberof
Tabs
Parameters
- newTabIndex: number
- triggeredByObserver: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:173

`Private` _changeActiveHeaderItem

_changeActiveHeaderItem(newHeaderItem: ITabsHeaderItem): void
Private
Method to change the active header item

Memberof
Tabs
Parameters
- newHeaderItem: ITabsHeaderItem
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:206

`Private` _getTargetIndex

_getTargetIndex(tabIndex: number): number
Private
Method to determine the next target index on changeTab method

Returns
{number}

Memberof
Tabs
Parameters
- tabIndex: number
Returns number
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:227

`Private` _handleKeypressEvent

_handleKeypressEvent(e: KeyboardEvent): void
Private
Method that handles the Keypress Event, for tabs navigation using arrows

Returns
{void}

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

`Private` _handleOnResizeEvent

_handleOnResizeEvent(): void
Private
Method to adjust the tabs css active item on resize or orientation-change

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:332

`Private` _handleTabIndicator

_handleTabIndicator(): void
Private
Method that handles the indicator size and transition

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:343

`Private` _prepareHeaderAndContentItems

_prepareHeaderAndContentItems(): void
Private
Method to make neccessary preparations for header and content items, that can't be done on their scope

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:421

`Private` _removeContentItem

_removeContentItem(childContentId: string): void
Private
Method that it's called whenever a new TabsContentItem is destroyed

Memberof
Tabs
Parameters
- childContentId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:463

`Private` _removeEvents

_removeEvents(): void
Private
Remove Pattern Events

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:509

`Private` _removeHeaderItem

_removeHeaderItem(childHeaderId: string): void
Private
Method that it's called whenever a new TabsHeaderItem is destroyed

Memberof
Tabs
Parameters
- childHeaderId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:534

`Private` _scrollToTargetContent

_scrollToTargetContent(newContentItem: ITabsContentItem): void
Private
Method to scroll to new target content item

Memberof
Tabs
Parameters
- newContentItem: ITabsContentItem
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:581

`Private` _setContentAutoHeight

_setContentAutoHeight(hasAutoHeight: boolean): void
Private
Method to set if the Tabs AutoHeight

Memberof
Tabs
Parameters
- hasAutoHeight: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:599

`Private` _setDragObserver

_setDragObserver(): void
Private
Method to set an IntersectionObserver when drag gestures are enable, to detect the activeItem on drag

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:619

`Private` _setHeaderItemsCustomProperty

_setHeaderItemsCustomProperty(itemsLength: number): void
Private
Method to set the CSS variable that holds the number of header items

Memberof
Tabs
Parameters
- itemsLength: number
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:656

`Private` _setHeight

_setHeight(height: string): void
Private
Method to set the Tabs Height

Memberof
Tabs
Parameters
- height: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:668

`Private` _setInitialOptions

_setInitialOptions(): void
Private
Method to set the initial options on screen load

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:690

`Private` _setIsJustified

_setIsJustified(isJustified: boolean): void
Private
Method to set if the Tabs are justified

Memberof
Tabs
Parameters
- isJustified: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:714

`Private` _setOrientation

_setOrientation(orientation: Orientation): void
Private
Method to set the Tabs Orientation

Memberof
Tabs
Parameters
- orientation: Orientation
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:734

`Private` _setPosition

_setPosition(position: OSFramework.OSUI.GlobalEnum.Direction): void
Private
Method to set the Tabs Position

Memberof
Tabs
Parameters
- position: OSFramework.OSUI.GlobalEnum.Direction
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:754

`Private` _setTabHeaderItemDisabledStatus

_setTabHeaderItemDisabledStatus(childHeaderId: string, isDisabled: boolean): void
Private
Toggle TableHeaderItem disbaled status

Memberof
Tabs
Parameters
- childHeaderId: string
- isDisabled: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:769

`Private` _tabHeaderItemHasBeenClicked

_tabHeaderItemHasBeenClicked(childHeaderId: string): void
Private
Method to change between tabs

Memberof
Tabs
Parameters
- childHeaderId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:827

`Private` _triggerOnChangeEvent

_triggerOnChangeEvent(activeTab: number): void
Private
Method that triggers the OnTabsChange event

Memberof
Tabs
Parameters
- activeTab: number
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:846

`Private` _unsetDragObserver

_unsetDragObserver(): void
Private
Method to remove the drag Observer on each contentItem

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:858

`Private` _updateItemsConnection

_updateItemsConnection(updateDataTab??: boolean): void
Private
Method that handles the connection between HeaderItems and ContentItem, related to data-tab and aria-controls/labbeledby

Memberof
Tabs
Parameters
- Optional updateDataTab: boolean = true
Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:869

`Private` _updateListOfEnabledTabsHeader

_updateListOfEnabledTabsHeader(): void
Private
Function that will update the list of enabled tabs headers

Memberof
Tabs

Returns void
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:909

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Method that adds the necessary attributes and listeners to the Tabs header

Memberof
OSFramework.Patterns.Tabs.Tabs

Returns void
Overrides AbstractParent.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:921

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to set the callbacks and event listeners

Memberof
OSFramework.Patterns.Tabs.Tabs

Returns void
Overrides AbstractParent.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:934

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to assign the html elements to the header and content wrappers

Memberof
OSFramework.Patterns.Tabs.Tabs

Returns void
Overrides AbstractParent.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:946

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Removes the listeners that were added in the code and unsets the callbacks.

Memberof
OSFramework.Patterns.Tabs.Tabs

Returns void
Overrides AbstractParent.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:958

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to unset the html elements references

Memberof
OSFramework.Patterns.Tabs.Tabs

Returns void
Overrides AbstractParent.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:977

beNotifiedByChild

beNotifiedByChild(childItem: OSFramework.OSUI.Patterns.TabsHeaderItem.TabsHeaderItem | OSFramework.OSUI.Patterns.TabsContentItem.TabsContentItem, notifiedTo: OSFramework.OSUI.Patterns.Tabs.Enum.ChildNotifyActionType): void
Method used to be notified by a given ChildId about a given action and act accordingly

Memberof
SectionIndex
Parameters
- childItem: OSFramework.OSUI.Patterns.TabsHeaderItem.TabsHeaderItem | OSFramework.OSUI.Patterns.TabsContentItem.TabsContentItem
- notifiedTo: OSFramework.OSUI.Patterns.Tabs.Enum.ChildNotifyActionType
  
  {Enum.ChildNotifyActionType} triggered notification type
Returns void
Implementation of ITabs.beNotifiedByChild

Overrides AbstractParent.beNotifiedByChild
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:990

build

build(): void
Method to build the Tabs

Memberof
OSFramework.Patterns.Tabs.Tabs

Returns void
Implementation of ITabs.build

Overrides AbstractParent.build
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:1036

changeProperty

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

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

Overrides AbstractParent.changeProperty
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:1061

changeTab

changeTab(tabIndex??: number, tabsHeaderItem?: ITabsHeaderItem, triggerEvent??: boolean, triggeredByObserver??: boolean): void
Method to change between tabs

Returns
{void}

Memberof
OSFramework.Patterns.Tabs.Tabs
Parameters
- Optional tabIndex: number = ...
- Optional tabsHeaderItem: ITabsHeaderItem
- Optional triggerEvent: boolean = false
- Optional triggeredByObserver: boolean = false
Returns void
Implementation of ITabs.changeTab
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:1100

dispose

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

Memberof
OSFramework.Patterns.Tabs.Tabs

Returns void
Implementation of ITabs.dispose

Overrides AbstractParent.dispose
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:1157

registerCallback

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

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

Overrides AbstractParent.registerCallback
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:1172

toggleDragGestures

toggleDragGestures(addDragGestures: boolean): void
Method to set the drag gestures necessary configurations

Memberof
OSFramework.Patterns.Tabs.Tabs
Parameters
- addDragGestures: boolean
Returns void
Implementation of ITabs.toggleDragGestures
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:1190

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _activeTabContentElement

_activeTabContentElement: ITabsContentItem

`Private` _activeTabHeaderElement

_activeTabHeaderElement: ITabsHeaderItem

`Private` _currentOrientation

_currentOrientation: Orientation

`Private` _currentVerticalPositon

_currentVerticalPositon: OSFramework.OSUI.GlobalEnum.Direction

`Private` _dragObserver

_dragObserver: IntersectionObserver

`Private` _eventOnHeaderKeypress

_eventOnHeaderKeypress: Generic

`Private` _eventOnResize

_eventOnResize: Generic

`Private` _hasDragGestures

_hasDragGestures: boolean

`Private` _hasSingleContent

_hasSingleContent: boolean

`Private` _headerItemsLength

_headerItemsLength: number

`Private` _platformEventTabsOnChange

_platformEventTabsOnChange: OSFramework.OSUI.Patterns.Tabs.Callbacks.OSOnChangeEvent

`Private` _requestAnimationFrameOnIndicatorResize

_requestAnimationFrameOnIndicatorResize: number

`Private` _tabsContentElement

_tabsContentElement: HTMLElement

`Private` _tabsHeaderElement

_tabsHeaderElement: HTMLElement

`Private` _tabsHeadersEnabled

_tabsHeadersEnabled: ITabsHeaderItem[]

`Private` _tabsIndicatorElement

_tabsIndicatorElement: HTMLElement

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractParent._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 ITabs.selfElement

Inherited from AbstractParent.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 ITabs.isBuilt

Inherited from AbstractParent.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 AbstractParent.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 ITabs.uniqueId

Inherited from AbstractParent.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 ITabs.widgetId

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

Constructors

constructor

new Tabs(uniqueId: string, configs: JSON): OSFramework.OSUI.Patterns.Tabs.Tabs
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.Tabs.Tabs
Overrides AbstractParent.constructor
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:48

Class Tabs

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Properties

Accessors

Constructors

Methods

Protected getChild

Returns

Memberof

Parameters

childId: string

Returns ITabsHeaderItem | ITabsContentItem

Protected getChildByIndex

Returns

Memberof

Parameters

index: number

Optional childType: string

Returns ITabsHeaderItem | ITabsContentItem

Protected getChildIndex

Returns

Memberof

Parameters

childId: string

Returns number

Protected setChild

Memberof

Parameters

childItem: ITabsHeaderItem | ITabsContentItem

Returns void

Protected unsetChild

Memberof

Parameters

childId: string

Returns void

getChildItems

Returns

Memberof

Parameters

Optional type: string

Returns (ITabsHeaderItem | ITabsContentItem)[]

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 _addContentItem

Memberof

Parameters

tabsContentChildItem: OSFramework.OSUI.Patterns.TabsContentItem.TabsContentItem

Returns void

Private _addEvents

Memberof

Returns void

Private _addHeaderItem

Memberof

Parameters

`Protected` getChild

`Protected` getChildByIndex

`Optional` childType: string

`Protected` getChildIndex

`Protected` setChild

`Protected` unsetChild

`Optional` type: string

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _addContentItem

`Private` _addEvents

`Private` _addHeaderItem

`Private` _changeActiveContentItem

`Private` _changeActiveHeaderItem

`Private` _getTargetIndex

`Private` _handleKeypressEvent

`Private` _handleOnResizeEvent

`Private` _handleTabIndicator

`Private` _prepareHeaderAndContentItems

`Private` _removeContentItem

`Private` _removeEvents

`Private` _removeHeaderItem

`Private` _scrollToTargetContent

`Private` _setContentAutoHeight

`Private` _setDragObserver

`Private` _setHeaderItemsCustomProperty

`Private` _setHeight