Class Tooltip

Defines the interface for OutSystemsUI Tooltip Pattern

Hierarchy-Diagram

UML class diagram of Tooltip
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 protected method in the UML class diagram protected method
icon for a private method in the UML class diagram private method
italic abstract property/method

Hierarchy

Implements

Methods

finishBuild equalsToID _moveBalloonElement _onBalloonClick _onBalloonWrapperMouseEnter _onBalloonWrapperMouseLeave _onBlur _onBodyClick _onBodyScroll _onClick _onFocus _onIconMouseEnter _onIconMouseLeave _onOpenedBalloon _onWindowResize _setBalloonCoordinates _setBalloonPosition _setBalloonWrapperExtendedClass _setCssClasses _setObserver _setUpEvents _triggerClose _triggerOpen _unsetEvents _unsetObserver _updateIsHover _updateIsVisible setA11YProperties setCallbacks setHtmlElements unsetCallbacks unsetHtmlElements build changeProperty close dispose open registerCallback

Accessors

_enableAccessibility selfElement isBuilt configs uniqueId widgetId IsOpen

Properties

_eventBalloonWrapperOnMouseEnter _eventBalloonWrapperOnMouseLeave _eventIconOnMouseEnter _eventIconOnMouseLeave _eventOnBalloonClick _eventOnBlur _eventOnBodyClick _eventOnBodyScroll _eventOnClick _eventOnFocus _eventOnOpenedBalloon _eventOnWindowResize _intersectionObserver _isBalloonWrapperMouseEnter _isIconMouseEnter _isOpen _isOpenedByApi _platformEventInitializedCallback _platformEventOnToggleCallback _requestAnimationOnBodyScroll _requestAnimationOnWindowResize _selfElementBoundingClientRect _tooltipBalloonContentActiveElem _tooltipBalloonContentElem _tooltipBalloonPositionClass _tooltipBalloonWrapperElem _tooltipIconElem

Constructors

constructor

Methods

Protected finishBuild

equalsToID

Private _moveBalloonElement

Private _onBalloonClick

Private _onBalloonWrapperMouseEnter

Private _onBalloonWrapperMouseLeave

Private _onBlur

Private _onBodyClick

Private _onBodyScroll

Private _onClick

Private _onFocus

Private _onIconMouseEnter

Private _onIconMouseLeave

Private _onOpenedBalloon

Private _onWindowResize

Private _setBalloonCoordinates

Private _setBalloonPosition

  • _setBalloonPosition(isIntersecting: boolean, boundingClientRect: DOMRect): void

  • Parameters

    • isIntersecting: boolean
    • boundingClientRect: DOMRect

    Returns void

Private _setBalloonWrapperExtendedClass

  • _setBalloonWrapperExtendedClass(newExtendedClass: string, preExtendedClass?: string): void

  • Parameters

    • newExtendedClass: string
    • preExtendedClass: string = ''

    Returns void

Private _setCssClasses

Private _setObserver

Private _setUpEvents

Private _triggerClose

Private _triggerOpen

Private _unsetEvents

Private _unsetObserver

Private _updateIsHover

Private _updateIsVisible

Protected setA11YProperties

Protected setCallbacks

Protected setHtmlElements

Protected unsetCallbacks

Protected unsetHtmlElements

build

changeProperty

  • 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

close

dispose

open

registerCallback

  • 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

Accessors

Protected _enableAccessibility

  • get _enableAccessibility(): boolean
  • Protected

    Getter that allows to obtain the accessibility is enabled.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns boolean

selfElement

isBuilt

configs

  • get configs(): C

  • Current configurations/state of the pattern.

    Memberof

    OSFramework.Patterns.AbstractPattern

    Returns C

uniqueId

widgetId

IsOpen

  • get IsOpen(): boolean

  • Getter that allows to obtain the IsOpen status.

    Memberof

    OSFramework.Patterns.Tooltip.Tooltip

    Returns boolean

Properties

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 _eventOnBodyClick

_eventOnBodyClick: Generic

Private _eventOnBodyScroll

_eventOnBodyScroll: Generic

Private _eventOnClick

_eventOnClick: Generic

Private _eventOnFocus

_eventOnFocus: Generic

Private _eventOnOpenedBalloon

_eventOnOpenedBalloon: Generic

Private _eventOnWindowResize

_eventOnWindowResize: Generic

Private _intersectionObserver

_intersectionObserver: IntersectionObserver

Private _isBalloonWrapperMouseEnter

_isBalloonWrapperMouseEnter: boolean = false

Private _isIconMouseEnter

_isIconMouseEnter: boolean = false

Private _isOpen

_isOpen: boolean

Private _isOpenedByApi

_isOpenedByApi: boolean = false

Private _platformEventInitializedCallback

_platformEventInitializedCallback: OSGeneric

Private _platformEventOnToggleCallback

_platformEventOnToggleCallback: OSGeneric

Private _requestAnimationOnBodyScroll

_requestAnimationOnBodyScroll: number

Private _requestAnimationOnWindowResize

_requestAnimationOnWindowResize: number

Private _selfElementBoundingClientRect

_selfElementBoundingClientRect: DOMRect = ...

Private _tooltipBalloonContentActiveElem

_tooltipBalloonContentActiveElem: HTMLElement

Private _tooltipBalloonContentElem

_tooltipBalloonContentElem: HTMLElement

Private _tooltipBalloonPositionClass

_tooltipBalloonPositionClass: string = ''

Private _tooltipBalloonWrapperElem

_tooltipBalloonWrapperElem: HTMLElement

Private _tooltipIconElem

_tooltipIconElem: HTMLElement

Constructors

constructor

Settings

Member Visibility

Theme