Class AnimatedLabel

Class that implements the AnimatedLabel pattern.

Export

Implements

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<AnimatedLabelConfig>
- AnimatedLabel

Implements

IAnimatedLabel

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 IAnimatedLabel.changeProperty

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

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

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

`Private` _addEvents

_addEvents(): void
Returns void
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:34

`Private` _inputAnimationStartCallback

_inputAnimationStartCallback(e: AnimationEvent): void
Parameters
- e: AnimationEvent
Returns void
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:41

`Private` _inputBlurCallback

_inputBlurCallback(evt: UIEvent): void
Parameters
- evt: UIEvent
Returns void
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:48

`Private` _inputFocusCallback

_inputFocusCallback(evt: UIEvent): void
Parameters
- evt: UIEvent
Returns void
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:55

`Private` _inputStateToggle

_inputStateToggle(isFocus: boolean): void
Parameters
- isFocus: boolean
Returns void
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:63

`Private` _removeEvents

_removeEvents(): void
Returns void
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:82

`Protected` setA11YProperties

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

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:91

`Protected` setCallbacks

setCallbacks(): void
Protected
Set the callbacks that will be assigned to the window click event

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:101

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Update info based on htmlContent

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:115

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Removes the listeners that were added in the code and unsets the callbacks.

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:147

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:161

build

build(): void
Builds the animation label.

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Implementation of IAnimatedLabel.build

Overrides AbstractPattern.build
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:172

dispose

dispose(): void
Destroy the Animatedlabel.

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Implementation of IAnimatedLabel.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:190

updateOnRender

updateOnRender(): void
Update Label active status accordingly when the input info has changed.

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Implementation of IAnimatedLabel.updateOnRender
- Defined in OSFramework/Pattern/AnimatedLabel/AnimatedLabel.ts:204

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

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

Properties

`Private` _eventAnimationStart

_eventAnimationStart: Generic

`Private` _eventBlur

_eventBlur: Generic

`Private` _eventFocus

_eventFocus: Generic

`Private` _inputElement

_inputElement: HTMLInputElement | HTMLTextAreaElement

`Private` _inputPhElement

_inputPhElement: HTMLElement

`Private` _isLabelFocus

_isLabelFocus: boolean

`Private` _labelPhElement

_labelPhElement: HTMLElement

Constructors

constructor

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

Class AnimatedLabel

Export

Implements

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

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _addEvents

Returns void

Private _inputAnimationStartCallback

Parameters

e: AnimationEvent

Returns void

Private _inputBlurCallback

Parameters

evt: UIEvent

Returns void

Private _inputFocusCallback

Parameters

evt: UIEvent

Returns void

Private _inputStateToggle

Parameters

isFocus: boolean

Returns void

Private _removeEvents

Returns void

Protected setA11YProperties

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

build

Memberof

Returns void

dispose

Memberof

Returns void

updateOnRender

Memberof

Returns void

Accessors

Protected _enableAccessibility

Memberof

Returns boolean

selfElement

Memberof

Returns HTMLElement

isBuilt

Memberof

`Protected` finishBuild

`Private` _addEvents

`Private` _inputAnimationStartCallback

`Private` _inputBlurCallback

`Private` _inputFocusCallback

`Private` _inputStateToggle

`Private` _removeEvents

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility

`Private` _eventAnimationStart

`Private` _eventBlur

`Private` _eventFocus

`Private` _inputElement

`Private` _inputPhElement

`Private` _isLabelFocus

`Private` _labelPhElement