Class Tooltip

Defines the interface for OutSystemsUI Tooltip Pattern

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<TooltipConfig>
- Tooltip

Implements

ITooltip

Index

Accessors

_enableAccessibility selfElement isBuilt configs uniqueId widgetId IsOpen

Constructors

constructor

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _arrowElem

_arrowElem: HTMLElement

`Private` _balloonElem

_balloonElem: HTMLElement

`Private` _balloonFeature

_balloonFeature: IBalloon

`Private` _eventBalloonOnToggle

_eventBalloonOnToggle: Generic

`Private` _eventBalloonWrapperOnMouseEnter

_eventBalloonWrapperOnMouseEnter: Generic

`Private` _eventBalloonWrapperOnMouseLeave

_eventBalloonWrapperOnMouseLeave: Generic

`Private` _eventIconOnMouseEnter

_eventIconOnMouseEnter: Generic

`Private` _eventIconOnMouseLeave

_eventIconOnMouseLeave: Generic

`Private` _eventOnBalloonClick

_eventOnBalloonClick: Generic

`Private` _eventOnBlur

_eventOnBlur: Generic

`Private` _eventOnClick

_eventOnClick: Generic

`Private` _eventOnFocus

_eventOnFocus: Generic

`Private` _eventOnKeypress

_eventOnKeypress: Generic

`Private` _isBalloonWrapperMouseEnter

_isBalloonWrapperMouseEnter: boolean = false

`Private` _isIconMouseEnter

_isIconMouseEnter: boolean = false

`Private` _isOpen

_isOpen: boolean = false

`Private` _isOpenedByApi

_isOpenedByApi: boolean = false

`Private` _platformEventOnToggleCallback

_platformEventOnToggleCallback: OSGeneric

`Private` _tooltipBalloonContentActiveElem

_tooltipBalloonContentActiveElem: HTMLElement

`Private` _tooltipBalloonContentElem

_tooltipBalloonContentElem: HTMLElement

`Private` _tooltipBalloonWrapperElem

_tooltipBalloonWrapperElem: HTMLElement

`Private` _tooltipIconElem

_tooltipIconElem: HTMLElement

balloonOptions

balloonOptions: BalloonOptions

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

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

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

`Private` _balloonOnToggleCallback

_balloonOnToggleCallback(_args: string, e: CustomEvent<any>): void
Parameters
- _args: string
- e: CustomEvent<any>
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:53

`Private` _onBalloonClick

_onBalloonClick(e: MouseEvent): void
Parameters
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:61

`Private` _onBalloonWrapperMouseEnter

_onBalloonWrapperMouseEnter(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:88

`Private` _onBalloonWrapperMouseLeave

_onBalloonWrapperMouseLeave(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:93

`Private` _onBlur

_onBlur(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:104

`Private` _onClick

_onClick(e: MouseEvent): void
Parameters
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:135

`Private` _onFocus

_onFocus(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:141

`Private` _onIconMouseEnter

_onIconMouseEnter(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:146

`Private` _onIconMouseLeave

_onIconMouseLeave(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:155

`Private` _onkeypressCallback

_onkeypressCallback(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:166

`Private` _setBalloonFeature

_setBalloonFeature(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:175

`Private` _setCssClasses

_setCssClasses(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:186

`Private` _setUpEvents

_setUpEvents(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:199

`Private` _transformPosition

_transformPosition(tooltipPosition: Position): OSFramework.OSUI.GlobalEnum.FloatingPosition
Parameters
- tooltipPosition: Position
Returns OSFramework.OSUI.GlobalEnum.FloatingPosition
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:237

`Private` _triggerClose

_triggerClose(isFromBalloonEvent?: boolean): void
Parameters
- isFromBalloonEvent: boolean = false
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:265

`Private` _triggerOpen

_triggerOpen(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:283

`Private` _unsetEvents

_unsetEvents(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:304

`Private` _updateIsHover

_updateIsHover(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:330

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Add the Accessibility Attributes values

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:349

`Protected` setCallbacks

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

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:368

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Update info based on htmlContent

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:387

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:402

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Unsets the refences to the HTML elements.

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:421

build

build(): void
Method to build the Tooltip

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Implementation of ITooltip.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:434

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Update property value from a given property name at OnParametersChange

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Parameters
- propertyName: string
  
  the name of the property that will be changed
- propertyValue: unknown
  
  the new value that should be assigned to the given property name
Returns void
Implementation of ITooltip.changeProperty

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:452

close

close(): void
Close the tooltip

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Implementation of ITooltip.close
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:483

dispose

dispose(): void
Destroy the tooltip

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Implementation of ITooltip.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:494

open

open(): void
Open the tooltip

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns void
Implementation of ITooltip.open
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:507

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method used to register the provider callback

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Parameters
- eventName: string
  
  Event name that will be assigned
- callback: OSGeneric
  
  Function name that will be passed as a callback function to the event above
Returns void
Implementation of ITooltip.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:521

setBalloonOptions

setBalloonOptions(balloonOptions?: BalloonOptions): void
Method to set the Balloon options

Memberof
Tooltip
Parameters
- Optional balloonOptions: BalloonOptions
Returns void
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:540

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

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

IsOpen

get IsOpen(): boolean
Getter that allows to obtain the IsOpen status.

Memberof
OSFramework.Patterns.Tooltip.Tooltip

Returns boolean
Implementation of ITooltip.IsOpen
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:578

Constructors

constructor

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

Class Tooltip

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _arrowElem

Private _balloonElem

Private _balloonFeature

Private _eventBalloonOnToggle

Private _eventBalloonWrapperOnMouseEnter

Private _eventBalloonWrapperOnMouseLeave

Private _eventIconOnMouseEnter

Private _eventIconOnMouseLeave

Private _eventOnBalloonClick

Private _eventOnBlur

Private _eventOnClick

Private _eventOnFocus

Private _eventOnKeypress

Private _isBalloonWrapperMouseEnter

Private _isIconMouseEnter

Private _isOpen

Private _isOpenedByApi

Private _platformEventOnToggleCallback

Private _tooltipBalloonContentActiveElem

Private _tooltipBalloonContentElem

Private _tooltipBalloonWrapperElem

Private _tooltipIconElem

balloonOptions

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

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _balloonOnToggleCallback

Parameters

_args: string

e: CustomEvent<any>

Returns void

Private _onBalloonClick

Parameters

e: MouseEvent

Returns void

Private _onBalloonWrapperMouseEnter

Returns void

Private _onBalloonWrapperMouseLeave

Returns void

Private _onBlur

Returns void

Private _onClick

Parameters

e: MouseEvent

Returns void

Private _onFocus

Returns void

Private _onIconMouseEnter

Returns void

`Protected` isProviderBased

`Private` _arrowElem

`Private` _balloonElem

`Private` _balloonFeature

`Private` _eventBalloonOnToggle

`Private` _eventBalloonWrapperOnMouseEnter

`Private` _eventBalloonWrapperOnMouseLeave

`Private` _eventIconOnMouseEnter

`Private` _eventIconOnMouseLeave

`Private` _eventOnBalloonClick

`Private` _eventOnBlur

`Private` _eventOnClick

`Private` _eventOnFocus

`Private` _eventOnKeypress

`Private` _isBalloonWrapperMouseEnter

`Private` _isIconMouseEnter

`Private` _isOpen

`Private` _isOpenedByApi

`Private` _platformEventOnToggleCallback

`Private` _tooltipBalloonContentActiveElem

`Private` _tooltipBalloonContentElem

`Private` _tooltipBalloonWrapperElem

`Private` _tooltipIconElem

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _balloonOnToggleCallback

`Private` _onBalloonClick

`Private` _onBalloonWrapperMouseEnter

`Private` _onBalloonWrapperMouseLeave

`Private` _onBlur

`Private` _onClick

`Private` _onFocus

`Private` _onIconMouseEnter

`Private` _onIconMouseLeave

`Private` _onkeypressCallback

`Private` _setBalloonFeature

`Private` _setCssClasses

`Private` _setUpEvents

`Private` _transformPosition

`Private` _triggerClose

`Private` _triggerOpen

`Private` _unsetEvents

`Private` _updateIsHover

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Optional` balloonOptions: BalloonOptions