Class Tooltip

Defines the interface for OutSystemsUI Tooltip Pattern

Hierarchy (View Summary)

AbstractPattern<TooltipConfig>
- Tooltip

Implements

ITooltip

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

balloonOptions

balloonOptions: BalloonOptions

Accessors

`Protected`_enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns boolean

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Implementation of ITooltip.IsOpen
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:586

Methods

`Protected`finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

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

Returns void

Memberof
AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ITooltip.equalsToID

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

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Add the Accessibility Attributes values

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:357

`Protected`setCallbacks

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

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:376

`Protected`setHtmlElements

setHtmlElements(): void
Protected
Update info based on htmlContent

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:395

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:410

`Protected`unsetHtmlElements

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

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:429

build

build(): void
Method to build the Tooltip

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Implementation of ITooltip.build

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

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Update property value from a given property name at OnParametersChange
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

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Implementation of ITooltip.changeProperty

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

close

close(): void
Close the tooltip

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Implementation of ITooltip.close
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:491

dispose

dispose(): void
Destroy the tooltip

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Implementation of ITooltip.dispose

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

open

open(): void
Open the tooltip

Returns void

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Implementation of ITooltip.open
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:515

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method used to register the provider callback
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

Memberof
OSFramework.Patterns.Tooltip.Tooltip
Implementation of ITooltip.registerCallback

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

setBalloonOptions

setBalloonOptions(balloonOptions?: BalloonOptions): void
Method to set the Balloon options
Parameters
- OptionalballoonOptions: BalloonOptions
Returns void

Memberof
Tooltip
- Defined in OSFramework/OSUI/Pattern/Tooltip/Tooltip.ts:548

Class Tooltip

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.Tooltip.Tooltip

Properties

ProtectedisProviderBased

balloonOptions

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

IsOpen

Returns boolean

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

ProtectedsetA11YProperties

Returns void

Memberof

ProtectedsetCallbacks

Returns void

Memberof

ProtectedsetHtmlElements

Returns void

Memberof

ProtectedunsetCallbacks

Returns void

Memberof

ProtectedunsetHtmlElements

Returns void

Memberof

build

Returns void

Memberof

changeProperty

Parameters

Returns void

Memberof

close

Returns void

Memberof

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements