Class TooltipController<W, C>

The default implementation of BaseTooltipController. Used by TooltipContainer, which lets you provide an anchor point to position the tooltip around.

Type Parameters

W extends Widget = Widget
C extends TooltipContainer = TooltipContainer

Hierarchy (view full)

BaseTooltipController<W, C, readonly [relAnchorX: number, relAnchorY: number]>
- TooltipController

Index

Constructors

Properties

tooltipContainer tooltipWrapper topLayeredContainer

Accessors

Methods

addLayer clearTopLayeredContainer doTooltipRectUpdate findTopLayeredContainer removeLayer updateTooltipRect

Constructors

constructor

new TooltipController<W, C>(tooltipWrapper, tooltipContainer): TooltipController<W, C>
Type Parameters
- W extends Widget = Widget
- C extends TooltipContainer<Widget> = TooltipContainer<Widget>
Parameters
- tooltipWrapper: W
- tooltipContainer: C
Returns TooltipController<W, C>
Inherited from BaseTooltipController.constructor
- Defined in src/helpers/BaseTooltipController.ts:17

Properties

`Readonly`tooltipContainer

tooltipContainer: C

`Readonly`tooltipWrapper

tooltipWrapper: W

`Protected`topLayeredContainer

topLayeredContainer: null | LayeredContainer<Widget> = null

The top-most container in the current UI tree

Accessors

hasLayer

get hasLayer(): boolean
Returns boolean
Inherited from BaseTooltipController.hasLayer
- Defined in src/helpers/BaseTooltipController.ts:106

Methods

addLayer

addLayer(relAnchorPos): boolean
Add a layer for the TooltipController#tooltipContainer. If there is a layer and adding another one would succeed, remove the old one.
Parameters
- relAnchorPos: readonly [number, number]
Returns boolean
True if the layer was addedd successfully, or false if there was no top layered container.
Overrides BaseTooltipController.addLayer
- Defined in src/helpers/TooltipController.ts:11

clearTopLayeredContainer

clearTopLayeredContainer(): void
Clear the top-most layered container. You must call this when the wrapper widget is detached from a parent.

Removes the current layer if there is any.

Returns void
Inherited from BaseTooltipController.clearTopLayeredContainer
- Defined in src/helpers/BaseTooltipController.ts:57

`Protected`doTooltipRectUpdate

doTooltipRectUpdate(): void
Implementation for BaseTooltipController#updateTooltipRect. Must be implemented by base class. BaseTooltipController#topLayeredContainer is guaranteed to be set when this method is called.

Returns void
Overrides BaseTooltipController.doTooltipRectUpdate
- Defined in src/helpers/TooltipController.ts:24

findTopLayeredContainer

findTopLayeredContainer(): void
Find the top-most layered container that is an ascendant of the BaseTooltipController#tooltipWrapper. You must call this when the wrapper widget is attached to a parent.

Removes the current layer if there is any, and if the top-most layered container changed.

Returns void
Inherited from BaseTooltipController.findTopLayeredContainer
- Defined in src/helpers/BaseTooltipController.ts:27

removeLayer

removeLayer(): void
Remove the layer of the TooltipController#tooltipContainer if there is any.

Returns void
Inherited from BaseTooltipController.removeLayer
- Defined in src/helpers/BaseTooltipController.ts:88

updateTooltipRect

updateTooltipRect(): void
Update the TooltipContainer#tooltipRect of the TooltipController#tooltipContainer.

Returns void
Inherited from BaseTooltipController.updateTooltipRect
- Defined in src/helpers/BaseTooltipController.ts:114