Class TabsConfig

Contains the configurations shared with all patterns.

Export

Abstract

Hierarchy-Diagram

UML class diagram of TabsConfig

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for a public property in the UML class diagram

public property

icon for a public method in the UML class diagram

public method

icon for a protected method in the UML class diagram

protected method

Hierarchy

AbstractConfiguration
- TabsConfig

Index

Properties

ExtendedClass ContentAutoHeight Height JustifyHeaders StartingTab TabsOrientation TabsVerticalPosition

Constructors

Methods

validateBoolean validateDate validateInRange validateNumber validateString validateTime validateCanChange validateDefault

Properties

ExtendedClass

ExtendedClass: string

ContentAutoHeight

ContentAutoHeight: boolean

Height

Height: string

JustifyHeaders

JustifyHeaders: boolean

StartingTab

StartingTab: number

TabsOrientation

TabsOrientation: Orientation

TabsVerticalPosition

TabsVerticalPosition: OSFramework.GlobalEnum.Direction

Constructors

constructor

new TabsConfig(config: JSON): TabsConfig
Parameters
- config: JSON
Returns TabsConfig
Inherited from AbstractConfiguration.constructor
- Defined in OSFramework/Pattern/AbstractConfiguration.ts:13

Methods

`Protected` validateBoolean

validateBoolean(value: boolean, defaultValue: boolean): boolean
Protected
Method that helps to validate if a boolean is not undefined

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: boolean
- defaultValue: boolean
Returns boolean
Inherited from AbstractConfiguration.validateBoolean
- Defined in OSFramework/Pattern/AbstractConfiguration.ts:31

`Protected` validateDate

validateDate(value: string | Date, defaultValue: string): string | Date
Protected
Method that helps to validate if a given value is a valid date

Returns
{(string | Date)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string | Date
- defaultValue: string
Returns string | Date
Inherited from AbstractConfiguration.validateDate
- Defined in OSFramework/Pattern/AbstractConfiguration.ts:44

`Protected` validateInRange

validateInRange(value: unknown, defaultValue: unknown, ...args: unknown[]): unknown
Protected
Method that helps to validate if a given value is within a range of values.

Returns
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: unknown
- defaultValue: unknown
- Rest ...args: unknown[]
Returns unknown
Inherited from AbstractConfiguration.validateInRange
- Defined in OSFramework/Pattern/AbstractConfiguration.ts:58

`Protected` validateNumber

validateNumber(value: number, defaultValue: number): number
Protected
Method that helps to validate if a number is not empty or undefined.

Returns
{number}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: number
- defaultValue: number
Returns number
Inherited from AbstractConfiguration.validateNumber
- Defined in OSFramework/Pattern/AbstractConfiguration.ts:80

`Protected` validateString

validateString(value: string, defaultValue: string): string
Protected
Method that helps to validate if a string is not empty or undefined.

Returns
{string}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string
- defaultValue: string
Returns string
Inherited from AbstractConfiguration.validateString
- Defined in OSFramework/Pattern/AbstractConfiguration.ts:93

`Protected` validateTime

validateTime(value: string, defaultValue: string): string
Protected
Method that helps to validate if a given value is a valid time

Returns
{(string)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string
- defaultValue: string
Returns string
Inherited from AbstractConfiguration.validateTime
- Defined in OSFramework/Pattern/AbstractConfiguration.ts:106

validateCanChange

validateCanChange(isBuilt: boolean, key: string): boolean
Method that will check if a given property (key) can be changed/updated!

Returns
boolean

Memberof
OSFramework.Patterns.Tabs.TabsConfig
Parameters
- isBuilt: boolean
  
  True when pattern has been built!
- key: string
  
  property name
Returns boolean
Overrides AbstractConfiguration.validateCanChange
- Defined in OSFramework/Pattern/Tabs/TabsConfig.ts:19

validateDefault

validateDefault(key: string, value: unknown): unknown
Method that will check if a given property (key) value is the type expected!

Returns
value

Memberof
OSFramework.Patterns.Tabs.TabsConfig
Parameters
- key: string
  
  property name
- value: unknown
  
  value to be check
Returns unknown
Overrides AbstractConfiguration.validateDefault
- Defined in OSFramework/Pattern/Tabs/TabsConfig.ts:34