Class Popover

java.lang.Object

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

org.patternfly.component.popover.Popover

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLDivElement, Popover>, ElementClassListMethods<HTMLDivElement, Popover>, ElementConsumerMethods<HTMLDivElement, Popover>, ElementContainerMethods<HTMLDivElement, Popover>, ElementEventMethods<HTMLDivElement, Popover>, ElementIdMethods<HTMLDivElement, Popover>, ElementQueryMethods<HTMLDivElement>, HTMLElementAttributeMethods<HTMLDivElement, Popover>, HTMLElementDataMethods<HTMLDivElement, Popover>, HTMLElementStyleMethods<HTMLDivElement, Popover>, HTMLElementVisibilityMethods<HTMLDivElement, Popover>, IsElement<HTMLDivElement>, TypedBuilder<HTMLDivElement, Popover>, Closeable<HTMLDivElement, Popover>, Component, ComponentIcon<HTMLDivElement, Popover>, Modifiers.NoPadding<HTMLDivElement, Popover>

public class Popover
extends BaseComponent<HTMLDivElement, Popover>
implements Attachable, Closeable<HTMLDivElement, Popover>, ComponentIcon<HTMLDivElement, Popover>, Modifiers.NoPadding<HTMLDivElement, Popover>

A popover is in-app messaging that provides more information on specific product areas. Popovers display content in a new window that overlays the current page. Unlike modals, popovers don't block the current page.

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

See Also:

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

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
Popover	add(PopoverBody body)
Popover	add(PopoverFooter footer)
Popover	add(PopoverHeader header)
Popover	addBody(String body)
Popover	addBody(PopoverBody body)
Popover	addFooter(String footer)
Popover	addFooter(PopoverFooter footer)
Popover	addHeader(String header)
Popover	addHeader(PopoverHeader header)
Popover	ariaCloseLabel(String label)	Accessible label for the close button.
Popover	ariaLabel(String label)	Accessible label for the popover, required when a header is not present.
void	attach(MutationRecord mutationRecord)
Popover	autoWidth()
Popover	closable()
Popover	closable(CloseHandler<Popover> closeHandler)
void	close(Event event, boolean fireEvent)
void	detach(MutationRecord mutationRecord)
Popover	distance(int distance)
Popover	entryDelay(int delay)
Popover	exitDelay(int delay)
Popover	hoverable()
Popover	hoverable(boolean hoverable)
Popover	icon(Element icon)
Popover	noClose()
Popover	onClose(CloseHandler<Popover> closeHandler)
Popover	placement(Placement placement)
static Popover	popover()
static Popover	popover(HTMLElement trigger)
static Popover	popover(Supplier<HTMLElement> trigger)
static Popover	popover(By trigger)
Popover	removeIcon()
void	show()
Popover	status(Severity severity)
Popover	status(Severity severity, String screenReaderText)
Popover	that()
Popover	trigger(HTMLElement trigger)
Popover	trigger(String trigger)
Popover	trigger(Supplier<HTMLElement> trigger)
Popover	trigger(By trigger)

Methods inherited from class BaseComponent

componentType, element, 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 ComponentIcon

icon

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 ElementContainerMethods

add, add, add, 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 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 Modifiers.NoPadding

noPadding, noPadding

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

popover

public static Popover popover()

popover

public static Popover popover(By trigger)

popover

public static Popover popover(HTMLElement trigger)

popover

public static Popover popover(Supplier<HTMLElement> trigger)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addHeader

public Popover addHeader(String header)

addHeader

public Popover addHeader(PopoverHeader header)

add

public Popover add(PopoverHeader header)

addBody

public Popover addBody(String body)

addBody

public Popover addBody(PopoverBody body)

add

public Popover add(PopoverBody body)

addFooter

public Popover addFooter(String footer)

addFooter

public Popover addFooter(PopoverFooter footer)

add

public Popover add(PopoverFooter footer)

autoWidth

public Popover autoWidth()

closable

public Popover closable()

closable

public Popover closable(CloseHandler<Popover> closeHandler)

distance

public Popover distance(int distance)

entryDelay

public Popover entryDelay(int delay)

exitDelay

public Popover exitDelay(int delay)

hoverable

public Popover hoverable()

hoverable

public Popover hoverable(boolean hoverable)

icon

public Popover icon(Element icon)

Specified by:

icon in interface ComponentIcon<HTMLDivElement, Popover>

removeIcon

public Popover removeIcon()

Specified by:

removeIcon in interface ComponentIcon<HTMLDivElement, Popover>

noClose

public Popover noClose()

placement

public Popover placement(Placement placement)

status

public Popover status(Severity severity)

status

public Popover status(Severity severity,
 String screenReaderText)

trigger

public Popover trigger(String trigger)

trigger

public Popover trigger(By trigger)

trigger

public Popover trigger(HTMLElement trigger)

trigger

public Popover trigger(Supplier<HTMLElement> trigger)

that

public Popover that()

Specified by:

that in interface TypedBuilder<HTMLDivElement, Popover>

ariaLabel

public Popover ariaLabel(String label)

Accessible label for the popover, required when a header is not present.

ariaCloseLabel

public Popover ariaCloseLabel(String label)

Accessible label for the close button.

onClose

public Popover onClose(CloseHandler<Popover> closeHandler)

Specified by:

onClose in interface Closeable<HTMLDivElement, Popover>

show

public void show()

close

public void close(Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<HTMLDivElement, Popover>