Class Tooltip

java.lang.Object

org.patternfly.component.BaseComponent<elemental2.dom.HTMLDivElement, Tooltip>

org.patternfly.component.tooltip.Tooltip

All Implemented Interfaces:

Attachable, ElementAttributeMethods<elemental2.dom.HTMLDivElement, Tooltip>, ElementClassListMethods<elemental2.dom.HTMLDivElement, Tooltip>, ElementConsumerMethods<elemental2.dom.HTMLDivElement, Tooltip>, ElementContainerDelegate<elemental2.dom.HTMLDivElement, Tooltip>, ElementContainerMethods<elemental2.dom.HTMLDivElement, Tooltip>, ElementEventMethods<elemental2.dom.HTMLDivElement, Tooltip>, ElementIdMethods<elemental2.dom.HTMLDivElement, Tooltip>, ElementQueryMethods<elemental2.dom.HTMLDivElement>, ElementTextDelegate<elemental2.dom.HTMLDivElement, Tooltip>, ElementTextMethods<elemental2.dom.HTMLDivElement, Tooltip>, HTMLElementAttributeMethods<elemental2.dom.HTMLDivElement, Tooltip>, HTMLElementDataMethods<elemental2.dom.HTMLDivElement, Tooltip>, HTMLElementStyleMethods<elemental2.dom.HTMLDivElement, Tooltip>, HTMLElementVisibilityMethods<elemental2.dom.HTMLDivElement, Tooltip>, IsElement<elemental2.dom.HTMLDivElement>, TypedBuilder<elemental2.dom.HTMLDivElement, Tooltip>, Closeable<elemental2.dom.HTMLDivElement, Tooltip>, Component, OuiaSupport<elemental2.dom.HTMLDivElement, Tooltip>

public class Tooltip
extends BaseComponent<elemental2.dom.HTMLDivElement, Tooltip>
implements Attachable, Closeable<elemental2.dom.HTMLDivElement, Tooltip>, ElementContainerDelegate<elemental2.dom.HTMLDivElement, Tooltip>, ElementTextDelegate<elemental2.dom.HTMLDivElement, Tooltip>

A tooltip is in-app messaging used to identify elements on a page with short, clarifying text.

This implementation uses the Popover API and CSS anchor positioning instead of Popper.js. The tooltip uses the browser's top-layer rendering for correct stacking, eliminating z-index issues.

See Also:

• https://www.patternfly.org/components/tooltip

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DISTANCE
static final int	ENTRY_DELAY
static final int	EXIT_DELAY

Method Summary

Modifier and Type	Method	Description
Tooltip	aria(TriggerAria aria)
void	attach(elemental2.dom.MutationRecord mutationRecord)
void	close(elemental2.dom.Event event, boolean fireEvent)
elemental2.dom.Element	containerDelegate()
void	detach(elemental2.dom.MutationRecord mutationRecord)
Tooltip	distance(int distance)
Tooltip	entryDelay(int delay)
Tooltip	exitDelay(int delay)
Tooltip	leftAligned()
Tooltip	onClose(CloseHandler<Tooltip> closeHandler)
Tooltip	placement(Placement placement)
void	show()
String	text()
elemental2.dom.Element	textDelegate()
Tooltip	that()
static Tooltip	tooltip()
static Tooltip	tooltip(elemental2.dom.HTMLElement trigger)
static Tooltip	tooltip(elemental2.dom.HTMLElement trigger, String text)
static Tooltip	tooltip(String text)
static Tooltip	tooltip(Supplier<elemental2.dom.HTMLElement> trigger)
static Tooltip	tooltip(Supplier<elemental2.dom.HTMLElement> trigger, String text)
static Tooltip	tooltip(By trigger)
static Tooltip	tooltip(By trigger, String text)
Tooltip	trigger(elemental2.dom.HTMLElement trigger)
Tooltip	trigger(String trigger)
Tooltip	trigger(Supplier<elemental2.dom.HTMLElement> trigger)
Tooltip	trigger(By trigger)

Methods inherited from class BaseComponent

componentType, element, ouiaComponentType, registerComponent

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Closeable

close, close

Methods inherited from interface ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface ElementConsumerMethods

apply, run

Methods inherited from interface ElementContainerDelegate

add, add, add

Methods inherited from interface ElementContainerMethods

add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface ElementEventMethods

on, on, on

Methods inherited from interface ElementIdMethods

id, uniqueId

Methods inherited from interface ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface ElementTextDelegate

text

Methods inherited from interface HTMLElementAttributeMethods

title

Methods inherited from interface HTMLElementDataMethods

data, data

Methods inherited from interface HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface HTMLElementVisibilityMethods

hidden

Methods inherited from interface IsElement

element

Methods inherited from interface OuiaSupport

initOuia, ouiaId, ouiaSafe, ouiaTransition

Field Details

DISTANCE

public static final int DISTANCE

See Also:

• Constant Field Values

ENTRY_DELAY

public static final int ENTRY_DELAY

See Also:

• Constant Field Values

EXIT_DELAY

public static final int EXIT_DELAY

See Also:

• Constant Field Values

Method Details

tooltip

public static Tooltip tooltip()

tooltip

public static Tooltip tooltip(String text)

tooltip

public static Tooltip tooltip(By trigger)

tooltip

public static Tooltip tooltip(By trigger,
 String text)

tooltip

public static Tooltip tooltip(elemental2.dom.HTMLElement trigger)

tooltip

public static Tooltip tooltip(elemental2.dom.HTMLElement trigger,
 String text)

tooltip

public static Tooltip tooltip(Supplier<elemental2.dom.HTMLElement> trigger)

tooltip

public static Tooltip tooltip(Supplier<elemental2.dom.HTMLElement> trigger,
 String text)

containerDelegate

public elemental2.dom.Element containerDelegate()

Specified by:

containerDelegate in interface ElementContainerDelegate<elemental2.dom.HTMLDivElement, Tooltip>

textDelegate

public elemental2.dom.Element textDelegate()

Specified by:

textDelegate in interface ElementTextDelegate<elemental2.dom.HTMLDivElement, Tooltip>

attach

public void attach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(elemental2.dom.MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

distance

public Tooltip distance(int distance)

entryDelay

public Tooltip entryDelay(int delay)

exitDelay

public Tooltip exitDelay(int delay)

leftAligned

public Tooltip leftAligned()

placement

public Tooltip placement(Placement placement)

trigger

public Tooltip trigger(String trigger)

trigger

public Tooltip trigger(By trigger)

trigger

public Tooltip trigger(elemental2.dom.HTMLElement trigger)

trigger

public Tooltip trigger(Supplier<elemental2.dom.HTMLElement> trigger)

that

public Tooltip that()

Specified by:

that in interface TypedBuilder<elemental2.dom.HTMLDivElement, Tooltip>

aria

public Tooltip aria(TriggerAria aria)

onClose

public Tooltip onClose(CloseHandler<Tooltip> closeHandler)

Specified by:

onClose in interface Closeable<elemental2.dom.HTMLDivElement, Tooltip>

show

public void show()

close

public void close(elemental2.dom.Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<elemental2.dom.HTMLDivElement, Tooltip>

text

public String text()

Specified by:

text in interface ElementTextDelegate<elemental2.dom.HTMLDivElement, Tooltip>

Specified by:

text in interface ElementTextMethods<elemental2.dom.HTMLDivElement, Tooltip>