Class ButtonLoading

Class that implements the ButtonLoading pattern.

Export

Implements

Hierarchy-Diagram

UML class diagram of ButtonLoading

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 an interface in the UML class diagram

interface

icon for a public property in the UML class diagram

public property

icon for a private property in the UML class diagram

private 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

icon for a private method in the UML class diagram

private method

italic abstract property/method

Hierarchy

AbstractPattern<ButtonLoadingConfig>
- ButtonLoading

Implements

IButtonLoading

Index

Methods

finishBuild equalsToID _setInitialButtonState _setIsLoading _setLoadingLabel setA11YProperties setCallbacks setHtmlElements unsetCallbacks unsetHtmlElements build changeProperty dispose

Accessors

_enableAccessibility selfElement isBuilt configs uniqueId widgetId

Properties

_buttonElement _spinnerElement

Constructors

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

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

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

`Private` _setInitialButtonState

_setInitialButtonState(): void
Returns void
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:24

`Private` _setIsLoading

_setIsLoading(isLoading: boolean): void
Parameters
- isLoading: boolean
Returns void
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:32

`Private` _setLoadingLabel

_setLoadingLabel(showSpinnerOnly: boolean): void
Parameters
- showSpinnerOnly: boolean
Returns void
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:44

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Add the Accessibility Attributes values

Memberof
OSFramework.Patterns.ButtonLoading.ButtonLoading

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:59

`Protected` setCallbacks

setCallbacks(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.ButtonLoading.ButtonLoading

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:71

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Update info based on htmlContent

Memberof
OSFramework.Patterns.ButtonLoading.ButtonLoading

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:81

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.ButtonLoading.ButtonLoading

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:111

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Removes the local value of the variables pointing to HTML elements;

Memberof
OSFramework.Patterns.ButtonLoading.ButtonLoading

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:121

build

build(): void
Builds the button loading.

Memberof
OSFramework.Patterns.ButtonLoading.ButtonLoading

Returns void
Implementation of IButtonLoading.build

Overrides AbstractPattern.build
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:131

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Applies the changes of state/value of the configurations.

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

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:150

dispose

dispose(): void
Disposes the current pattern.

Memberof
OSFramework.Patterns.ButtonLoading.ButtonLoading

Returns void
Implementation of IButtonLoading.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:171

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 IButtonLoading.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 IButtonLoading.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 IButtonLoading.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 IButtonLoading.widgetId

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

Properties

`Private` _buttonElement

_buttonElement: HTMLElement

`Private` _spinnerElement

_spinnerElement: HTMLElement

Constructors

constructor

new ButtonLoading(uniqueId: string, configs: JSON): OSFramework.Patterns.ButtonLoading.ButtonLoading
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.Patterns.ButtonLoading.ButtonLoading
Overrides AbstractPattern.constructor
- Defined in OSFramework/Pattern/ButtonLoading/ButtonLoading.ts:19