Class Tabs

Defines the interface for OutSystemsUI Patterns

Export

Tabs

Implements

Hierarchy (View Summary)

OSFramework.OSUI.Patterns.AbstractParent<
    TabsConfig,
    ITabsContentItem
    | ITabsHeaderItem,
>
- Tabs

Implements

ITabs

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractParent._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractParent.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ITabs.widgetId

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

Methods

`Protected`getChild

getChild(childId: string): ITabsHeaderItem | ITabsContentItem
Protected
Get the child reference based on given Id
Parameters
- childId: string
  Child Id of the element to be found
Returns ITabsHeaderItem | ITabsContentItem
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
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
Parameters
- index: number
  Index of the item to be returned
- OptionalchildType: string
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns ITabsHeaderItem | ITabsContentItem
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
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
Parameters
- childId: string
  Child id where index will be found
Returns number
Index value

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.getChildIndex
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:72

`Protected`notifyChildren

notifyChildren(notificationType: string): void
Method used to notify all children about a given notification type
Parameters
- notificationType: string
  Notification type
Returns void

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.notifyChildren
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:87

`Protected`setChild

setChild(childItem: ITabsHeaderItem | ITabsContentItem): void
Protected
Method that is used to set a given child as a Parent child.
Parameters
- childItem: ITabsHeaderItem | ITabsContentItem
  Reference to be added
Returns void

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.setChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:102

`Protected`unsetChild

unsetChild(childId: string): void
Protected
Method that will remove Child by given Id
Parameters
- childId: string
  Id of the item that will be removed
Returns void

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.unsetChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:134

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!
Parameters
- Optionaltype: string
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns (ITabsHeaderItem | ITabsContentItem)[]

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.getChildItems
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:199

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractParent.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Returns void

Memberof
AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ITabs.equalsToID

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

`Protected`setA11YProperties

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

Returns void

Memberof
OSFramework.Patterns.Tabs.Tabs
Overrides AbstractParent.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:780

`Protected`setCallbacks

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

Returns void

Memberof
OSFramework.Patterns.Tabs.Tabs
Overrides AbstractParent.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:795

`Protected`setHtmlElements

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

Returns void

Memberof
OSFramework.Patterns.Tabs.Tabs
Overrides AbstractParent.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:809

`Protected`unsetCallbacks

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

Returns void

Memberof
OSFramework.Patterns.Tabs.Tabs
Overrides AbstractParent.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:821

`Protected`unsetHtmlElements

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

Returns void

Memberof
OSFramework.Patterns.Tabs.Tabs
Overrides AbstractParent.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:840

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
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

Memberof
SectionIndex
Implementation of ITabs.beNotifiedByChild

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

build

build(): void
Method to build the Tabs

Returns void

Memberof
OSFramework.Patterns.Tabs.Tabs
Implementation of ITabs.build

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

changeProperty

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

Memberof
OSFramework.Patterns.Tabs.Tabs
Implementation of ITabs.changeProperty

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

changeTab

changeTab(
    tabIndex?: number,
    tabsHeaderItem?: ITabsHeaderItem,
    triggerEvent?: boolean,
    triggeredByObserver?: boolean,
): void
Method to change between tabs
Parameters
- OptionaltabIndex: number = ...
- OptionaltabsHeaderItem: ITabsHeaderItem
- OptionaltriggerEvent: boolean = false
- OptionaltriggeredByObserver: boolean = false
Returns void
{void}

Memberof
OSFramework.Patterns.Tabs.Tabs
Implementation of ITabs.changeTab
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:963

dispose

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

Returns void

Memberof
OSFramework.Patterns.Tabs.Tabs
Implementation of ITabs.dispose

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

registerCallback

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

Memberof
OSFramework.Patterns.Tabs.Tabs
Implementation of ITabs.registerCallback

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

toggleDragGestures

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

Memberof
OSFramework.Patterns.Tabs.Tabs
Implementation of ITabs.toggleDragGestures
- Defined in OSFramework/OSUI/Pattern/Tabs/Tabs.ts:1053

Class Tabs

Export

Implements

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.Tabs.Tabs

Properties

ProtectedisProviderBased

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

Methods

ProtectedgetChild

Parameters

Returns ITabsHeaderItem | ITabsContentItem

Memberof

ProtectedgetChildByIndex

Parameters

Returns ITabsHeaderItem | ITabsContentItem

Memberof

ProtectedgetChildIndex

Parameters

Returns number

Memberof

ProtectednotifyChildren

Parameters

Returns void

Memberof

ProtectedsetChild

Parameters

Returns void

Memberof

ProtectedunsetChild

Parameters

Returns void

Memberof

getChildItems

Parameters

Returns (ITabsHeaderItem | ITabsContentItem)[]

Memberof

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`getChild

`Protected`getChildByIndex

`Protected`getChildIndex

`Protected`notifyChildren

`Protected`setChild

`Protected`unsetChild

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements