Package org.patternfly.component.tooltip

Class Tooltip

java.lang.Object

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

org.patternfly.component.tooltip.Tooltip

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLDivElement,Tooltip>, ElementClassListMethods<HTMLDivElement,Tooltip>, ElementConsumerMethods<HTMLDivElement,Tooltip>, ElementContainerMethods<HTMLDivElement,Tooltip>, ElementEventMethods<HTMLDivElement,Tooltip>, ElementIdMethods<HTMLDivElement,Tooltip>, ElementQueryMethods<HTMLDivElement>, ElementTextMethods<HTMLDivElement,Tooltip>, HTMLElementAttributeMethods<HTMLDivElement,Tooltip>, HTMLElementDataMethods<HTMLDivElement,Tooltip>, HTMLElementStyleMethods<HTMLDivElement,Tooltip>, HTMLElementVisibilityMethods<HTMLDivElement,Tooltip>, IsElement<HTMLDivElement>, TypedBuilder<HTMLDivElement,Tooltip>, Closeable<HTMLDivElement,Tooltip>, Component

public class Tooltip
extends BaseComponent<HTMLDivElement,Tooltip>
implements Attachable, Closeable<HTMLDivElement,Tooltip>, ElementTextMethods<HTMLDivElement,Tooltip>

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Tooltip	animationDuration(int animationDuration)
Tooltip	appendTo(Node node)
Tooltip	appendToBody()
Tooltip	aria(TriggerAria aria)
void	attach(MutationRecord mutationRecord)
void	close(Event event, boolean fireEvent)
void	detach(MutationRecord mutationRecord)
Tooltip	distance(int distance)
Tooltip	entryDelay(int delay)
Tooltip	exitDelay(int delay)
Tooltip	flip(boolean flip)
Tooltip	leftAligned()
Tooltip	onClose(org.patternfly.handler.CloseHandler<Tooltip> closeHandler)
Tooltip	placement(org.patternfly.popper.Placement placement)
void	show()
void	show(Event event)
String	text()
Tooltip	text(String text)
Tooltip	that()
static Tooltip	tooltip()
static Tooltip	tooltip(HTMLElement trigger)
static Tooltip	tooltip(HTMLElement trigger, String text)
static Tooltip	tooltip(String text)
static Tooltip	tooltip(Supplier<HTMLElement> trigger)
static Tooltip	tooltip(Supplier<HTMLElement> trigger, String text)
static Tooltip	tooltip(By trigger)
static Tooltip	tooltip(By trigger, String text)
Tooltip	trigger(HTMLElement trigger)
Tooltip	trigger(String trigger)
Tooltip	trigger(Supplier<HTMLElement> trigger)
Tooltip	trigger(By trigger)
Tooltip	triggerActions(org.patternfly.popper.TriggerAction... triggerActions)
Tooltip	zIndex(int zIndex)

Methods inherited from class org.patternfly.component.BaseComponent

componentType, element

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.patternfly.component.Closeable

close, close

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

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

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

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

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Field Details

ANIMATION_DURATION

public static final int ANIMATION_DURATION

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

DISTANCE

public static final int DISTANCE

See Also:

• Constant Field Values

Z_INDEX

public static final int Z_INDEX

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(HTMLElement trigger)

tooltip

public static Tooltip tooltip(HTMLElement trigger,
 String text)

tooltip

public static Tooltip tooltip(Supplier<HTMLElement> trigger)

tooltip

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

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

appendToBody

public Tooltip appendToBody()

appendTo

public Tooltip appendTo(Node node)

animationDuration

public Tooltip animationDuration(int animationDuration)

distance

public Tooltip distance(int distance)

flip

public Tooltip flip(boolean flip)

entryDelay

public Tooltip entryDelay(int delay)

exitDelay

public Tooltip exitDelay(int delay)

leftAligned

public Tooltip leftAligned()

placement

public Tooltip placement(org.patternfly.popper.Placement placement)

text

public Tooltip text(String text)

Specified by:

text in interface ElementTextMethods<HTMLDivElement,Tooltip>

trigger

public Tooltip trigger(String trigger)

trigger

public Tooltip trigger(By trigger)

trigger

public Tooltip trigger(HTMLElement trigger)

trigger

public Tooltip trigger(Supplier<HTMLElement> trigger)

triggerActions

public Tooltip triggerActions(org.patternfly.popper.TriggerAction... triggerActions)

zIndex

public Tooltip zIndex(int zIndex)

that

public Tooltip that()

Specified by:

that in interface TypedBuilder<HTMLDivElement,Tooltip>

aria

public Tooltip aria(TriggerAria aria)

onClose

public Tooltip onClose(org.patternfly.handler.CloseHandler<Tooltip> closeHandler)

Specified by:

onClose in interface Closeable<HTMLDivElement,Tooltip>

show

public void show()

show

public void show(Event event)

close

public void close(Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<HTMLDivElement,Tooltip>

text

public String text()

Specified by:

text in interface ElementTextMethods<HTMLDivElement,Tooltip>