Class NativePopover

java.lang.Object

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

org.patternfly.component.popover.NativePopover

All Implemented Interfaces:

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

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

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DISTANCE

Method Summary

Modifier and Type	Method	Description
NativePopover	add(NativePopoverBody body)
NativePopover	add(NativePopoverFooter footer)
NativePopover	add(NativePopoverHeader header)
NativePopover	addBody(String body)
NativePopover	addBody(NativePopoverBody body)
NativePopover	addFooter(String footer)
NativePopover	addFooter(NativePopoverFooter footer)
NativePopover	addHeader(String header)
NativePopover	addHeader(NativePopoverHeader header)
NativePopover	ariaCloseLabel(String label)	Accessible label for the close button.
NativePopover	ariaLabel(String label)	Accessible label for the popover, required when header is not present.
void	attach(MutationRecord mutationRecord)
NativePopover	autoWidth()
NativePopover	closable()
NativePopover	closable(CloseHandler<NativePopover> closeHandler)
void	close(Event event, boolean fireEvent)
void	detach(MutationRecord mutationRecord)
NativePopover	distance(int distance)
NativePopover	icon(Element icon)
static NativePopover	nativePopover()
static NativePopover	nativePopover(HTMLElement trigger)
static NativePopover	nativePopover(Supplier<HTMLElement> trigger)
static NativePopover	nativePopover(By trigger)
NativePopover	noClose()
NativePopover	onClose(CloseHandler<NativePopover> closeHandler)
NativePopover	placement(Placement placement)
NativePopover	removeIcon()
void	show()
NativePopover	status(Severity severity)
NativePopover	status(Severity severity, String screenReaderText)
NativePopover	that()
NativePopover	trigger(HTMLElement trigger)
NativePopover	trigger(String trigger)
NativePopover	trigger(Supplier<HTMLElement> trigger)
NativePopover	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

Method Details

nativePopover

public static NativePopover nativePopover()

nativePopover

public static NativePopover nativePopover(By trigger)

nativePopover

public static NativePopover nativePopover(HTMLElement trigger)

nativePopover

public static NativePopover nativePopover(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 NativePopover addHeader(String header)

addHeader

public NativePopover addHeader(NativePopoverHeader header)

add

public NativePopover add(NativePopoverHeader header)

addBody

public NativePopover addBody(String body)

addBody

public NativePopover addBody(NativePopoverBody body)

add

public NativePopover add(NativePopoverBody body)

addFooter

public NativePopover addFooter(String footer)

addFooter

public NativePopover addFooter(NativePopoverFooter footer)

add

public NativePopover add(NativePopoverFooter footer)

autoWidth

public NativePopover autoWidth()

closable

public NativePopover closable()

closable

public NativePopover closable(CloseHandler<NativePopover> closeHandler)

distance

public NativePopover distance(int distance)

icon

public NativePopover icon(Element icon)

Specified by:

icon in interface ComponentIcon<HTMLDivElement, NativePopover>

removeIcon

public NativePopover removeIcon()

Specified by:

removeIcon in interface ComponentIcon<HTMLDivElement, NativePopover>

noClose

public NativePopover noClose()

placement

public NativePopover placement(Placement placement)

status

public NativePopover status(Severity severity)

status

public NativePopover status(Severity severity,
 String screenReaderText)

trigger

public NativePopover trigger(String trigger)

trigger

public NativePopover trigger(By trigger)

trigger

public NativePopover trigger(HTMLElement trigger)

trigger

public NativePopover trigger(Supplier<HTMLElement> trigger)

that

public NativePopover that()

Specified by:

that in interface TypedBuilder<HTMLDivElement, NativePopover>

ariaLabel

public NativePopover ariaLabel(String label)

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

ariaCloseLabel

public NativePopover ariaCloseLabel(String label)

Accessible label for the close button.

onClose

public NativePopover onClose(CloseHandler<NativePopover> closeHandler)

Specified by:

onClose in interface Closeable<HTMLDivElement, NativePopover>

show

public void show()

close

public void close(Event event,
 boolean fireEvent)

Specified by:

close in interface Closeable<HTMLDivElement, NativePopover>