The `goog.ui.Tooltip` Class

goog.ui.Tooltip
> goog.ui.Popup
> goog.ui.PopupBase
> goog.events.EventTarget
> goog.Disposable

`goog.ui.Tooltip(opt_el, opt_str, opt_domHelper)`

Tooltip widget. Can be attached to one or more elements and is shown, with a slight delay, when the the cursor is over the element or the element gains focus.

opt_el {Element|string=}: Element to display tooltip for, either element reference or string id.
opt_str {?string=}: Text message to display in tooltip.
opt_domHelper {goog.dom.DomHelper=}: Optional DOM helper.

The `goog.ui.Tooltip.Activation` Enum

Popup activation types. Used to select a positioning strategy. … more

The `goog.ui.Tooltip.CursorTooltipPosition` Class

Popup position implementation that positions the popup (the tooltip in this case) based on the cursor position. It's positioned below the cursor to the right if there's enough room to fit all of it inside the Viewport. Otherwise it's displayed as far right as possible either above or below the element. Used to position tooltips triggered by the cursor. … more

The `goog.ui.Tooltip.ElementTooltipPosition` Class

Popup position implementation that positions the popup (the tooltip in this case) based on the element position. It's positioned below the element to the right if there's enough room to fit all of it inside the Viewport. Otherwise it's displayed as far right as possible either above or below the element. Used to position tooltips triggered by focus changes. … more

The `goog.ui.Tooltip.State` Enum

Possible states for the tooltip to be in. … more

`.addEventListener(type, handler, opt_capture, opt_handlerScope)`

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}: The type of the event to listen for.
handler {Function|Object}: The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.
opt_capture {boolean=}: In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope {Object=}: Object in whose scope to call the listener.

`.addOnDisposeCallback(callback, opt_scope)`

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}: The callback function.
opt_scope {Object=}: An optional scope to call the callback in.

`.attach(el)`

Attach to element. Tooltip will be displayed when the cursor is over the element or when the element has been active for a few milliseconds.

el {Element|string}: Element to display tooltip for, either element reference or string id.

`.className` {`string`}

CSS class name for tooltip.

`.creationStack` {`string`}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

`.detach(opt_el)`

Detach from element(s).

opt_el {Element|string=}: Element to detach from, either element reference or string id. If no element is specified all are detached.

`.dispatchEvent(e)`

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}: Event object.
returns {boolean}: If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

`.dispose()`

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}: Nothing.

`.disposeInternal()`

`.getActiveElement()`

returns {Element}: Active element reference.

The goog.ui.Tooltip Class

goog.ui.Tooltip(opt_el, opt_str, opt_domHelper)

The goog.ui.Tooltip.Activation Enum

The goog.ui.Tooltip.CursorTooltipPosition Class

The goog.ui.Tooltip.ElementTooltipPosition Class

The goog.ui.Tooltip.State Enum

.addEventListener(type, handler, opt_capture, opt_handlerScope)

.addOnDisposeCallback(callback, opt_scope)

.anchor [protected] {Element|undefined}

.attach(el)

.className {string}

.clearHideTimer() [protected]

.clearShowTimer() [protected]

.creationStack {string}

.cursorPosition [protected] {!goog.math.Coordinate}

.detach(opt_el)

.dispatchEvent(e)

.dispose()

.disposeInternal()

.getActiveElement()

.getAnchorFromElement(el) [protected]

.getAutoHide()

.getAutoHideRegion()

.getChildTooltip() [protected]

.getDisposed [deprecated]

.getDomHelper()

.getElement()

.getElements() [protected]

.getEnableCrossIframeDismissal()

.getHideDelayMs()

.getHideOnEscape()

.getHtml()

.getLastHideTime()

.getLastShowTime()

.getMargin()

.getParentEventTarget()

.getPinnedCorner()

.getPosition()

.getPositioningStrategy(activationType) [protected]

.getShowDelayMs()

.getState()

.getText()

.getType()

.handleFocus(event) [protected]

.handleMouseMove(event) [protected]

.handleMouseOutAndBlur(event) [protected]

.handleMouseOver(event) [protected]

.handleTooltipMouseOut(event) [protected]

.handleTooltipMouseOver(event) [protected]

.hasActiveChild() [protected]

.hideTimer [protected] {number|undefined}

.isCoordinateInTooltip(coord)

.isDisposed()

.isOrWasRecentlyVisible()

.isVisible()

.maybeHide(el)

.maybeShow(el, opt_pos)

.onBeforeHide_(opt_target) [protected]

.onBeforeShow() [protected]

.onHide_() [protected]

.onShow_() [protected]

.registerDisposable(disposable)

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

.reposition()

.setActiveElement(activeEl) [protected]

.setAutoHide(autoHide)

.setAutoHideRegion(element)

.setElement(el)

.setEnableCrossIframeDismissal(enable)

.setHideDelayMs(delay)

.setHideOnEscape(hideOnEscape)

.setHtml(str)

.setMargin(arg1, opt_arg2, opt_arg3, opt_arg4)

.setParentEventTarget(parent)

.setPinnedCorner(corner)

.setPosition(position)

.setRequireInteraction(requireInteraction)

.setShouldHideAsync(b)

.setShowDelayMs(delay)

.setText(str)

The `goog.ui.Tooltip` Class

`goog.ui.Tooltip(opt_el, opt_str, opt_domHelper)`

The `goog.ui.Tooltip.Activation` Enum

The `goog.ui.Tooltip.CursorTooltipPosition` Class

The `goog.ui.Tooltip.ElementTooltipPosition` Class

The `goog.ui.Tooltip.State` Enum

`.addEventListener(type, handler, opt_capture, opt_handlerScope)`

`.addOnDisposeCallback(callback, opt_scope)`

`.anchor` [protected] {`Element`|`undefined`}

`.attach(el)`

`.className` {`string`}

`.clearHideTimer()` [protected]

`.clearShowTimer()` [protected]

`.creationStack` {`string`}

`.cursorPosition` [protected] {!`goog.math.Coordinate`}

`.detach(opt_el)`

`.dispatchEvent(e)`

`.dispose()`

`.disposeInternal()`

`.getActiveElement()`

`.getAnchorFromElement(el)` [protected]

`.getAutoHide()`

`.getAutoHideRegion()`

`.getChildTooltip()` [protected]

`.getDisposed` [deprecated]

`.getDomHelper()`

`.getElement()`

`.getElements()` [protected]

`.getEnableCrossIframeDismissal()`

`.getHideDelayMs()`

`.getHideOnEscape()`

`.getHtml()`

`.getLastHideTime()`

`.getLastShowTime()`

`.getMargin()`

`.getParentEventTarget()`

`.getPinnedCorner()`

`.getPosition()`

`.getPositioningStrategy(activationType)` [protected]

`.getShowDelayMs()`

`.getState()`

`.getText()`

`.getType()`

`.handleFocus(event)` [protected]

`.handleMouseMove(event)` [protected]

`.handleMouseOutAndBlur(event)` [protected]

`.handleMouseOver(event)` [protected]

`.handleTooltipMouseOut(event)` [protected]

`.handleTooltipMouseOver(event)` [protected]

`.hasActiveChild()` [protected]

`.hideTimer` [protected] {`number`|`undefined`}

`.isCoordinateInTooltip(coord)`

`.isDisposed()`

`.isOrWasRecentlyVisible()`

`.isVisible()`

`.maybeHide(el)`

`.maybeShow(el, opt_pos)`

`.onBeforeHide_(opt_target)` [protected]

`.onBeforeShow()` [protected]

`.onHide_()` [protected]

`.onShow_()` [protected]

`.registerDisposable(disposable)`

`.removeEventListener(type, handler, opt_capture, opt_handlerScope)`

`.reposition()`

`.setActiveElement(activeEl)` [protected]

`.setAutoHide(autoHide)`

`.setAutoHideRegion(element)`

`.setElement(el)`

`.setEnableCrossIframeDismissal(enable)`

`.setHideDelayMs(delay)`

`.setHideOnEscape(hideOnEscape)`

`.setHtml(str)`

`.setMargin(arg1, opt_arg2, opt_arg3, opt_arg4)`

`.setParentEventTarget(parent)`

`.setPinnedCorner(corner)`

`.setPosition(position)`

`.setRequireInteraction(requireInteraction)`

`.setShouldHideAsync(b)`

`.setShowDelayMs(delay)`

`.setText(str)`