Class AbstractProgress<C>`Abstract`

Defines the interface for OutSystemsUI Progress Patterns

Type Parameters

C extends ProgressConfiguration

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<C>
- AbstractProgress
  - Bar
  - Circle

Implements

IProgress

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.finishBuild
- Defined in OSFramework/Pattern/AbstractPattern.ts:50

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.

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of IProgress.changeProperty

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

dispose

dispose(): void
Disposes the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Implementation of IProgress.dispose

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

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of IProgress.equalsToID

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

`Protected` `Abstract` setA11YProperties

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

`Protected` `Abstract` setHtmlElements

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

`Private` _animateEntranceEnd

_animateEntranceEnd(): void
Returns void
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:17

`Private` _setAccessibilityProps

_setAccessibilityProps(): void
Returns void
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:25

`Protected` animateInitial

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

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:55

`Protected` animateOnValueChange

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

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:69

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to set the calbacks

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:83

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to unset the calbacks

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:93

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:103

`Protected` updatedProgressValue

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

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:113

build

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

Memberof
OSFramework.Interface.IBuilder

Returns void
Implementation of IProgress.build

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

`Protected` resetProgressValue

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

Memberof
OSFramework.Patterns.Progress.AbstractProgress

Returns void
Implementation of IProgress.resetProgressValue
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:162

`Protected` setProgressValue

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

Memberof
OSFramework.Patterns.Progress.AbstractProgress
Parameters
- value: number
Returns void
Implementation of IProgress.setProgressValue
- Defined in OSFramework/Pattern/Progress/AbstractProgress.ts:172

`Protected` `Abstract` addInitialAnimation

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

`Protected` `Abstract` setElementProgressValue

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

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/Pattern/AbstractPattern.ts:128

selfElement

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of IProgress.selfElement

Inherited from AbstractPattern.selfElement
- Defined in OSFramework/Pattern/AbstractPattern.ts:139

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of IProgress.isBuilt

Inherited from AbstractPattern.isBuilt
- Defined in OSFramework/Pattern/AbstractPattern.ts:150

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractPattern.configs
- Defined in OSFramework/Pattern/AbstractPattern.ts:161

uniqueId

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IProgress.uniqueId

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

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IProgress.widgetId

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

Properties

`Private` _eventAnimateEntranceEnd

_eventAnimateEntranceEnd: Generic

`Protected` _progressElem

_progressElem: HTMLElement

`Protected` _progressType

_progressType: ProgressTypes

Constructors

constructor

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

Class AbstractProgress<C>Abstract

Type Parameters

C extends ProgressConfiguration

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

Memberof

Returns void

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

dispose

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected Abstract setA11YProperties

Returns void

Protected Abstract setHtmlElements

Returns void

Private _animateEntranceEnd

Returns void

Private _setAccessibilityProps

Returns void

Protected animateInitial

Memberof

Returns void

Protected animateOnValueChange

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

Protected updatedProgressValue

Memberof

Returns void

build

Memberof

Returns void

Protected resetProgressValue

Memberof

Returns void

Protected setProgressValue

Memberof

Parameters

value: number

Returns void

Protected Abstract addInitialAnimation

Returns void

Protected Abstract setElementProgressValue

Parameters

value: number

Returns void

Accessors

Protected _enableAccessibility

Memberof

Returns boolean

selfElement

Memberof

Class AbstractProgress<C>`Abstract`

`Protected` finishBuild

`Protected` `Abstract` setA11YProperties

`Protected` `Abstract` setHtmlElements

`Private` _animateEntranceEnd

`Private` _setAccessibilityProps

`Protected` animateInitial

`Protected` animateOnValueChange

`Protected` setCallbacks

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` updatedProgressValue

`Protected` resetProgressValue

`Protected` setProgressValue

`Protected` `Abstract` addInitialAnimation

`Protected` `Abstract` setElementProgressValue

`Protected` _enableAccessibility

`Private` _eventAnimateEntranceEnd

`Protected` _progressElem

`Protected` _progressType