Class AbstractProgress<C>`Abstract`

Defines the interface for OutSystemsUI Progress Patterns

Constructors

constructor

new AbstractProgress<C extends ProgressConfiguration>(
uniqueId: string,
configs: C,
): AbstractProgress<C>
Type Parameters
- C extends ProgressConfiguration
Parameters
- uniqueId: string
- configs: C
Returns AbstractProgress<C>
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:13

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`contentElem

contentElem: HTMLElement

`Protected`gradientLength

gradientLength: number

`Protected`progressElem

progressElem: HTMLElement

`Protected`progressType

progressType: ProgressTypes

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern._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 IProgress.selfElement

Inherited from AbstractPattern.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 IProgress.isBuilt

Inherited from AbstractPattern.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 AbstractPattern.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 IProgress.uniqueId

Inherited from AbstractPattern.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 IProgress.widgetId

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

Methods

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.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 AbstractPattern.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 AbstractPattern.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 AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Changes the value of the properties in the configurations and if changes are to a common property, applies the changes.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IProgress.changeProperty

Inherited from AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:128

dispose

dispose(): void
Disposes the pattern.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IProgress.dispose

Inherited from AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:158

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 IProgress.equalsToID

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

`Abstract`registerCallback

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

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IProgress.registerCallback

Inherited from AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:184

`Protected` `Abstract`setA11YProperties

setA11YProperties(): void
Returns void
Inherited from AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:267

`Protected` `Abstract`setHtmlElements

setHtmlElements(): void
Returns void
Inherited from AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:269

`Protected`animateInitial

animateInitial(): void
Protected
Method to add the initial animation to progress

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:57

`Protected`animateOnValueChange

animateOnValueChange(): void
Protected
Method to add the animation to progress on value change

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:71

`Protected`setCallbacks

setCallbacks(): void
Protected
Method to set the calbacks

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:85

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Method to unset the calbacks

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:95

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to set the html elements used

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:105

`Protected`updatedProgressValue

updatedProgressValue(): void
Protected
Method to validate the value limits and apply the A11Y on progress, based on progress value

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:116

build

build(): void
Builds the pattern.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IProgress.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:153

progressApplyGradient

progressApplyGradient(gradientType: string, colors: GradientColor): void
Method to apply a CSS Gradient to the Progress
Parameters
- gradientType: string
- colors: GradientColor
Returns void

Memberof
AbstractProgress
Implementation of IProgress.progressApplyGradient
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:166

`Protected`resetProgressValue

resetProgressValue(): void
Protected
Method used to reset the progress value

Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Implementation of IProgress.resetProgressValue
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:183

`Protected`setProgressValue

setProgressValue(value: number): void
Protected
Method used to set the progress value
Parameters
- value: number
Returns void

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Implementation of IProgress.setProgressValue
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:193

`Protected` `Abstract`addInitialAnimation

addInitialAnimation(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:198

`Protected` `Abstract`setElementProgressValue

setElementProgressValue(value: number): void
Parameters
- value: number
Returns void
- Defined in OSFramework/OSUI/Pattern/Progress/AbstractProgress.ts:199

Class AbstractProgress<C>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractProgress<C>

Properties

ProtectedisProviderBased

ProtectedcontentElem

ProtectedgradientLength

ProtectedprogressElem

ProtectedprogressType

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

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

changeProperty

Parameters

Returns void

Memberof

dispose

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

AbstractregisterCallback

Parameters

Returns void

Memberof

Protected AbstractsetA11YProperties

Returns void

Protected AbstractsetHtmlElements

Returns void

ProtectedanimateInitial

Returns void

Memberof

ProtectedanimateOnValueChange

Returns void

Memberof

ProtectedsetCallbacks

Returns void

Class AbstractProgress<C>`Abstract`

`Protected`isProviderBased

`Protected`contentElem

`Protected`gradientLength

`Protected`progressElem

`Protected`progressType

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Abstract`registerCallback

`Protected` `Abstract`setA11YProperties

`Protected` `Abstract`setHtmlElements

`Protected`animateInitial

`Protected`animateOnValueChange

`Protected`setCallbacks

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Protected`updatedProgressValue

`Protected`resetProgressValue

`Protected`setProgressValue

`Protected` `Abstract`addInitialAnimation

`Protected` `Abstract`setElementProgressValue