Interface ITabsHeaderItem

Defines the interface for OutSystemsUI TabsHeaderItem Pattern

Export

Interface

ITabsHeaderItem

Hierarchy-Diagram

Legend

class

interface

public property

protected property

private property

public method

protected method

private method

Hierarchy

IChild
- ITabsHeaderItem

Implemented by

OSFramework.OSUI.Patterns.TabsHeaderItem.TabsHeaderItem

Index

Methods

build

build(): void
Build object, instantiating dependencies, and manipulating DOM when necessary

Memberof
OSFramework.Interface.IBuilder

Returns void
Inherited from IChild.build
- Defined in OSFramework/OSUI/Interface/IBuilder.ts:15

`Optional` setBlur

setBlur(): void
Method used to set item as focus state

Memberof
OSFramework.Interface.IChild

Returns void
Inherited from IChild.setBlur
- Defined in OSFramework/OSUI/Interface/IChild.ts:20

`Optional` setTabindex

setTabindex(): void
Method used to set the tabindex attribute

Memberof
OSFramework.Interface.IChild

Returns void
Inherited from IChild.setTabindex
- Defined in OSFramework/OSUI/Interface/IChild.ts:34

`Optional` unsetTabindex

unsetTabindex(): void
Method used to unset the tabindex attribute

Memberof
OSFramework.Interface.IChild

Returns void
Inherited from IChild.unsetTabindex
- Defined in OSFramework/OSUI/Interface/IChild.ts:41

dispose

dispose(): void
Dispose object and free up its used resources

Memberof
OSFramework.Interface.IDisposable

Returns void
Inherited from IChild.dispose
- Defined in OSFramework/OSUI/Interface/IDisposable.ts:15

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method signature to change the properties/configs of the pattern.

Memberof
OSFramework.Interface.IPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Inherited from IChild.changeProperty
- Defined in OSFramework/OSUI/Interface/IPattern.ts:52

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Enables to register simple callbacks for the platform. Internal use.

Memberof
OSFramework.Interface.IPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Inherited from IChild.registerCallback
- Defined in OSFramework/OSUI/Interface/IPattern.ts:61

equalsToID

equalsToID(id: string): boolean
Validates if object matched with the given id

Returns
{boolean}

Memberof
OSFramework.Interface.ISearchById
Parameters
- id: string
Returns boolean
Inherited from IChild.equalsToID
- Defined in OSFramework/OSUI/Interface/ISearchById.ts:17

disable

disable(): void
Method to disable TabHeaderItem

Memberof
ITabsHeaderItem

Returns void
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:24

enable

enable(): void
Method to enable TabHeaderItem

Memberof
ITabsHeaderItem

Returns void
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:31

getDataTab

getDataTab(): number
Method to get the current data-tab value

Returns
{number}

Memberof
ITabsHeaderItem

Returns number
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:39

setAriaControlsAttribute

setAriaControlsAttribute(contentItemId: string): void
Method to set the aria-controls attribute

Memberof
ITabsHeaderItem
Parameters
- contentItemId: string
  
  Element that will receive the aria-controls
Returns void
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:47

setDataTab

setDataTab(dataTab: number): void
Method to set the data-tab attribute

Memberof
ITabsHeaderItem
Parameters
- dataTab: number
  
  Tab that will be the active
Returns void
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:55

setFocus

setFocus(): void
Method to set the focus on item

Memberof
ITabsHeaderItem

Returns void
Overrides IChild.setFocus
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:62

setIsActive

setIsActive(): void
Method to set the element as active

Memberof
ITabsHeaderItem

Returns void
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:69

unsetIsActive

unsetIsActive(): void
Method to remove the element as active

Memberof
ITabsHeaderItem

Returns void
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:76

updateOnRender

updateOnRender(): void
Method to update tabs indicator size on HeaderItem onRender

Memberof
ITabsHeaderItem

Returns void
- Defined in OSFramework/OSUI/Pattern/TabsHeaderItem/ITabsHeaderItem.ts:83

Accessors

isFirstChild

get isFirstChild(): boolean
Returns boolean
Inherited from Interface.IChild.isFirstChild
- Defined in OSFramework/OSUI/Interface/IChild.ts:10
set isFirstChild(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Interface.IChild.isFirstChild
- Defined in OSFramework/OSUI/Interface/IChild.ts:11

isLastChild

get isLastChild(): boolean
Returns boolean
Inherited from Interface.IChild.isLastChild
- Defined in OSFramework/OSUI/Interface/IChild.ts:12
set isLastChild(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Interface.IChild.isLastChild
- Defined in OSFramework/OSUI/Interface/IChild.ts:13

Properties

isBuilt

isBuilt: boolean

Indicates if the instance of the pattern is built.

Memberof

OSFramework.Interface.IPattern

selfElement

selfElement: HTMLElement

Pattern HTML element

Memberof

OSFramework.Interface.IPattern

uniqueId

uniqueId: string

Internal Id of the instance of the pattern.

Memberof

OSFramework.Interface.IPattern

widgetId

widgetId: string

External Id of the instance of the pattern

Memberof

OSFramework.Interface.IPattern

IsActive

IsActive: boolean

Returns the value of active state

Memberof

ITabsHeaderItem

Interface ITabsHeaderItem

Export

Interface

Hierarchy-Diagram

Legend

Hierarchy

Implemented by

Index

Methods

Accessors

Properties

Methods

build

Memberof

Returns void

Optional setBlur

Memberof

Returns void

Optional setTabindex

Memberof

Returns void

Optional unsetTabindex

Memberof

Returns void

dispose

Memberof

Returns void

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

registerCallback

Memberof

Parameters

eventName: string

callback: OSGeneric

Returns void

equalsToID

Returns

Memberof

Parameters

id: string

Returns boolean

disable

Memberof

Returns void

enable

Memberof

Returns void

getDataTab

Returns

Memberof

Returns number

setAriaControlsAttribute

Memberof

Parameters

contentItemId: string

Returns void

setDataTab

Memberof

Parameters

dataTab: number

Returns void

setFocus

Memberof

Returns void

setIsActive

Memberof

Returns void

unsetIsActive

Memberof

Returns void

updateOnRender

Memberof

Returns void

Accessors

isFirstChild

Returns boolean

`Optional` setBlur

`Optional` setTabindex

`Optional` unsetTabindex