Class AnimatedLabel

Class that implements the AnimatedLabel pattern.

Export

Implements

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<AnimatedLabelConfig>
- AnimatedLabel

Implements

IAnimatedLabel

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _eventAnimationStart

_eventAnimationStart: Generic

`Private` _eventBlur

_eventBlur: Generic

`Private` _eventFocus

_eventFocus: Generic

`Private` _eventKeyDown

_eventKeyDown: Generic

`Private` _inputElement

_inputElement: HTMLInputElement | HTMLTextAreaElement

`Private` _inputPhElement

_inputPhElement: HTMLElement

`Private` _isLabelFocus

_isLabelFocus: boolean

`Private` _labelPhElement

_labelPhElement: HTMLElement

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/OSUI/Pattern/AbstractPattern.ts:61

`Protected` triggerPlatformEventCallback

triggerPlatformEventCallback(platFormCallback: OSGeneric, ...args: unknown[]): void
Protected
Triggers a generic platform event.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Memberof
AbstractPattern

Returns void
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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
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.

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

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

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/OSUI/Pattern/AbstractPattern.ts:172

registerCallback

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

Abstract

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IAnimatedLabel.registerCallback

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

`Private` _addEvents

_addEvents(): void
Private
Method to add Pattern Events

Memberof
AnimatedLabel

Returns void
- Defined in OSFramework/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:40

`Private` _inputAnimationStartCallback

_inputAnimationStartCallback(e: AnimationEvent): void
Private
Method to set callback to the event onAnimationStart

Memberof
AnimatedLabel
Parameters
- e: AnimationEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:56

`Private` _inputBlurCallback

_inputBlurCallback(evt: UIEvent): void
Private
Method to set callback to the event "blur" of the input

Memberof
AnimatedLabel
Parameters
- evt: UIEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:69

`Private` _inputFocusCallback

_inputFocusCallback(evt: UIEvent): void
Private
Method to set callback to the event "focus" of the input

Memberof
AnimatedLabel
Parameters
- evt: UIEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:82

`Private` _inputKeyDownCallback

_inputKeyDownCallback(evt: KeyboardEvent): void
Private
Method to set callback to the event "keydown" of the input

Memberof
AnimatedLabel
Parameters
- evt: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:95

`Private` _inputStateToggle

_inputStateToggle(isFocus??: boolean): void
Private
Method that implements the toggle of the state of the input. It can either add or remove the class "active" of the input.

Memberof
AnimatedLabel
Parameters
- Optional isFocus: boolean = false
Returns void
- Defined in OSFramework/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:112

`Private` _removeEvents

_removeEvents(): void
Private
Method to remove Pattern Events

Memberof
AnimatedLabel

Returns void
- Defined in OSFramework/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:144

`Protected` setA11YProperties

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

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

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to 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/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:166

`Protected` setHtmlElements

setHtmlElements(): void
Protected
method to update info based on htmlContent

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

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

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to remove 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/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:212

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

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

build

build(): void
Method to build the animation label.

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Implementation of IAnimatedLabel.build

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

dispose

dispose(): void
Method to destroy the Animatedlabel.

Memberof
OSFramework.Patterns.AnimatedLabel.AnimatedLabel

Returns void
Implementation of IAnimatedLabel.dispose

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

updateOnRender

updateOnRender(): void
Method to 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/OSUI/Pattern/AnimatedLabel/AnimatedLabel.ts:269

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/OSUI/Pattern/AbstractPattern.ts:207

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/OSUI/Pattern/AbstractPattern.ts:218

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/OSUI/Pattern/AbstractPattern.ts:229

configs

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

Memberof
OSFramework.Patterns.AbstractPattern

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

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/OSUI/Pattern/AbstractPattern.ts:251

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/OSUI/Pattern/AbstractPattern.ts:262

Constructors

constructor

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

Class AnimatedLabel

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _eventAnimationStart

Private _eventBlur

Private _eventFocus

Private _eventKeyDown

Private _inputElement

Private _inputPhElement

Private _isLabelFocus

Private _labelPhElement

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

registerCallback

Abstract

Memberof

Parameters

eventName: string

callback: OSGeneric

Returns void

Private _addEvents

Memberof

Returns void

Private _inputAnimationStartCallback

Memberof

Parameters

e: AnimationEvent

Returns void

Private _inputBlurCallback

Memberof

Parameters

evt: UIEvent

Returns void

Private _inputFocusCallback

Memberof

Parameters

evt: UIEvent

Returns void

Private _inputKeyDownCallback

Memberof

Parameters

evt: KeyboardEvent

Returns void

`Protected` isProviderBased

`Private` _eventAnimationStart

`Private` _eventBlur

`Private` _eventFocus

`Private` _eventKeyDown

`Private` _inputElement

`Private` _inputPhElement

`Private` _isLabelFocus

`Private` _labelPhElement

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _addEvents

`Private` _inputAnimationStartCallback

`Private` _inputBlurCallback

`Private` _inputFocusCallback

`Private` _inputKeyDownCallback

`Private` _inputStateToggle

`Optional` isFocus: boolean = false

`Private` _removeEvents

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility