Package org.patternfly.component.popover

Class Popover

java.lang.Object

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

org.patternfly.component.popover.Popover

All Implemented Interfaces:

Attachable, Container<HTMLDivElement,Popover>, Finder<HTMLDivElement>, HasElement<HTMLDivElement,Popover>, HasHTMLElement<HTMLDivElement,Popover>, IsElement<HTMLDivElement>, TypedBuilder<HTMLDivElement,Popover>, Closeable<HTMLDivElement,Popover>, Component, WithIcon<HTMLDivElement,Popover>, Modifiers.NoPadding<HTMLDivElement,Popover>

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

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.

See Also:

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

Field Summary

Fields

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

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	animationDuration(int animationDuration)
Popover	appendTo(Node node)
Popover	appendToBody()
Popover	ariaCloseLabel(String label)	Accessible label for the close button.
Popover	ariaLabel(String label)	Accessible label for the popover, required when 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	flip(boolean flip)
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()
Popover	severity(Severity severity)
Popover	severity(Severity severity, String screenReaderText)
void	show()
void	show(Event event)
Popover	that()
Popover	trigger(HTMLElement trigger)
Popover	trigger(String trigger)
Popover	trigger(Supplier<HTMLElement> trigger)
Popover	trigger(By trigger)
Popover	triggerActions(TriggerAction... triggerActions)
Popover	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.Container

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

Methods inherited from interface org.jboss.elemento.Finder

closest, find, findAll

Methods inherited from interface org.jboss.elemento.HasElement

add, apply, aria, aria, aria, attr, attr, attr, classList, classList, css, id, id, innerHtml, on, run, textContent, textNode, toggle, toggle, toggle, uniqueId

Methods inherited from interface org.jboss.elemento.HasHTMLElement

data, hidden, style, style, style, style, style, style, title

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface org.patternfly.style.Modifiers.NoPadding

noPadding, noPadding

Methods inherited from interface org.patternfly.component.WithIcon

icon

Field Detail

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 Detail

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)

appendToBody

public Popover appendToBody()

appendTo

public Popover appendTo(Node node)

animationDuration

public Popover animationDuration(int animationDuration)

autoWidth

public Popover autoWidth()

closable

public Popover closable()

closable

public Popover closable(CloseHandler<Popover> closeHandler)

distance

public Popover distance(int distance)

flip

public Popover flip(boolean flip)

icon

public Popover icon(Element icon)

Specified by:

icon in interface WithIcon<HTMLDivElement,Popover>

removeIcon

public Popover removeIcon()

Specified by:

removeIcon in interface WithIcon<HTMLDivElement,Popover>

noClose

public Popover noClose()

placement

public Popover placement(Placement placement)

severity

public Popover severity(Severity severity)

severity

public Popover severity(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)

triggerActions

public Popover triggerActions(TriggerAction... triggerActions)

zIndex

public Popover zIndex(int zIndex)

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

show

public void show(Event event)

close

public void close(Event event,
                  boolean fireEvent)

Specified by:

close in interface Closeable<HTMLDivElement,Popover>