Class SectionIndexItemConfig

Class that represents the custom configurations received by the SectionIndexItem.

Export

Hierarchy-Diagram

UML class diagram of SectionIndexItemConfig

Legend

class

abstract class

public property

public method

protected method

Hierarchy

AbstractConfiguration
- SectionIndexItemConfig

Index

Properties

ExtendedClass

ExtendedClass: string

ScrollToWidgetId

ScrollToWidgetId: string

Constructors

constructor

new SectionIndexItemConfig(config: JSON): SectionIndexItemConfig
Parameters
- config: JSON
Returns SectionIndexItemConfig
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

validateDefault

validateDefault(_key: string, value: unknown): unknown
Method that assures that the values being set as configurations respect the defaults.

Returns
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- _key: string
- value: unknown
Returns unknown
Inherited from AbstractConfiguration.validateDefault
- Defined in OSFramework/Pattern/AbstractConfiguration.ts:132

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.SectionIndexItem.SectionIndexItemConfig
Parameters
- isBuilt: boolean
  
  True when pattern has been built!
- key: string
  
  property name
Returns boolean
Overrides AbstractConfiguration.validateCanChange
- Defined in OSFramework/Pattern/SectionIndexItem/SectionIndexItemConfig.ts:21

Class SectionIndexItemConfig

Export

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Constructors

Methods

Properties

ExtendedClass

ScrollToWidgetId

Constructors

constructor

Parameters

config: JSON

Returns SectionIndexItemConfig

Methods

Protected validateBoolean

Returns

Memberof

Parameters

value: boolean

defaultValue: boolean

Returns boolean

Protected validateDate

Returns

Memberof

Parameters

value: string | Date

defaultValue: string

Returns string | Date

Protected validateInRange

Returns

Memberof

Parameters

value: unknown

defaultValue: unknown

Rest ...args: unknown[]

Returns unknown

Protected validateNumber

Returns

Memberof

Parameters

value: number

defaultValue: number

Returns number

Protected validateString

Returns

Memberof

Parameters

value: string

defaultValue: string

Returns string

Protected validateTime

Returns

Memberof

Parameters

value: string

defaultValue: string

Returns string

validateDefault

Returns

Memberof

Parameters

_key: string

value: unknown

Returns unknown

validateCanChange

Returns

Memberof

Parameters

isBuilt: boolean

key: string

Returns boolean

Settings

Member Visibility

Theme

`Protected` validateBoolean

`Protected` validateDate

`Protected` validateInRange

`Rest` ...args: unknown[]

`Protected` validateNumber

`Protected` validateString

`Protected` validateTime