Class Balloon<PT>

Class for the Balloon Feature

Export

Implements

Type Parameters

PT

Hierarchy-Diagram

UML class diagram of Balloon

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 private method in the UML class diagram

private method

Hierarchy

AbstractFeature<PT, BalloonOptions>
- Balloon

Implements

IBalloon

Accessors

featureElem

get featureElem(): HTMLElement
Getter for the feature Elemement

Memberof
AbstractFeature

Returns HTMLElement
Inherited from AbstractFeature.featureElem
- Defined in OSFramework/OSUI/Feature/AbstractFeature.ts:51

featureOptions

get featureOptions(): O
Getter for the feature options

Memberof
AbstractFeature

Returns O
Inherited from AbstractFeature.featureOptions
- Defined in OSFramework/OSUI/Feature/AbstractFeature.ts:62

featurePattern

get featurePattern(): PT
Getter for the the feature pattern element

Memberof
AbstractFeature

Returns PT
Inherited from AbstractFeature.featurePattern
- Defined in OSFramework/OSUI/Feature/AbstractFeature.ts:73

Properties

`Private` _currentFocusedElementIndex

_currentFocusedElementIndex: number

`Private` _eventBodyClick

_eventBodyClick: Generic

`Private` _eventOnKeypress

_eventOnKeypress: Generic

`Private` _eventOnWindowResize

_eventOnWindowResize: Generic

`Private` _floatingInstance

_floatingInstance: OSFramework.OSUI.Utils.FloatingPosition.FloatingPosition

`Private` _floatingOptions

_floatingOptions: FloatingPositionConfig

`Private` _focusManagerInstance

_focusManagerInstance: FocusManager

`Private` _focusTrapInstance

_focusTrapInstance: FocusTrap

`Private` _focusableBalloonElements

_focusableBalloonElements: NodeListOf<Element>

`Private` _isOpenedByApi

_isOpenedByApi: boolean = false

`Private` _onToggleEvent

_onToggleEvent: Generic

isOpen

isOpen: boolean = false

Constructors

constructor

new Balloon<PT>(featurePattern: PT, featureElem: HTMLElement, options: BalloonOptions): Balloon<PT>
Type Parameters
- PT
Parameters
- featurePattern: PT
- featureElem: HTMLElement
- options: BalloonOptions
Returns Balloon<PT>
Overrides AbstractFeature.constructor
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:56

Methods

`Private` _bodyClickCallback

_bodyClickCallback(_args: string, e: MouseEvent): void
Parameters
- _args: string
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:62

`Private` _handleFocusBehavior

_handleFocusBehavior(): void
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:85

`Private` _manageFocusInsideBalloon

_manageFocusInsideBalloon(arrowKeyPressed?: ArrowDown | ArrowUp): void
Parameters
- Optional arrowKeyPressed: ArrowDown | ArrowUp
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:101

`Private` _onKeypressCallback

_onKeypressCallback(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:147

`Private` _onWindowResize

_onWindowResize(): void
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:168

`Private` _removeEventListeners

_removeEventListeners(): void
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:176

`Private` _setA11YProperties

_setA11YProperties(): void
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:193

`Private` _setBalloonWidth

_setBalloonWidth(): void
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:219

`Private` _setCallbacks

_setCallbacks(): void
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:228

`Private` _setEventListeners

_setEventListeners(): void
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:243

`Private` _toggleBalloon

_toggleBalloon(isOpen: boolean, isBodyClick?: boolean, arrowKeyPressed?: ArrowDown | ArrowUp): void
Parameters
- isOpen: boolean
- isBodyClick: boolean = false
- Optional arrowKeyPressed: ArrowDown | ArrowUp
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:265

`Private` _unsetCallbacks

_unsetCallbacks(): void
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:335

build

build(): void
Method to build the Feature

Memberof
Balloon

Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:348

close

close(): void
Method to close the Balloon

Memberof
Balloon

Returns void
Implementation of IBalloon.close
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:367

dispose

dispose(): void
Destroy the Balloon.

Memberof
Balloon

Returns void
Implementation of IBalloon.dispose

Overrides AbstractFeature.dispose
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:378

open

open(isOpenedByApi: boolean, arrowKeyPressed?: ArrowDown | ArrowUp): void
Method to open the Balloon

Memberof
Balloon
Parameters
- isOpenedByApi: boolean
- Optional arrowKeyPressed: ArrowDown | ArrowUp
Returns void
Implementation of IBalloon.open
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:390

setBalloonShape

setBalloonShape(shape?: OSFramework.OSUI.GlobalEnum.ShapeTypes): void
Method to handle the Shape config css variable

Memberof
Balloon
Parameters
- Optional shape: OSFramework.OSUI.GlobalEnum.ShapeTypes
Returns void
Implementation of IBalloon.setBalloonShape
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:406

setFloatingBehaviour

setFloatingBehaviour(isUpdate?: boolean): void
Method to set the Floating Util

Memberof
Balloon
Parameters
- Optional isUpdate: boolean
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:424

setFloatingConfigs

setFloatingConfigs(): void
Method to set the Floating configs

Memberof
Balloon

Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:446

updateFloatingConfigs

updateFloatingConfigs(floatingConfigs?: FloatingPositionConfig): void
Method to update the FloatingUI options

Memberof
Balloon
Parameters
- Optional floatingConfigs: FloatingPositionConfig
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:467

updatePositionOption

updatePositionOption(position: OSFramework.OSUI.GlobalEnum.FloatingPosition): void
Method to update the Position config on the FloatingUI

Memberof
Balloon
Parameters
- position: OSFramework.OSUI.GlobalEnum.FloatingPosition
Returns void
Implementation of IBalloon.updatePositionOption
- Defined in OSFramework/OSUI/Feature/Balloon/Balloon.ts:481