org.dominokit.domino.ui.popover

Class Popover

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,Popover>

org.dominokit.domino.ui.popover.Popover

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,Popover,Popover>, HasChildren<Popover>, HasWavesElement, IsCollapsible<Popover>, IsReadOnly<Popover>, Switchable<Popover>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class Popover
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Popover>
implements Switchable<Popover>

A component for showing content on top of another element in different locations.

Customize the component can be done by overwriting classes provided by PopoverStyles

For example:

     Popover.create(element, "Popover", Paragraph.create("This is a popover"));
 

See Also:

BaseDominoElement, Switchable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Popover.CloseHandler A handler to be called when closing the popover
static interface	Popover.OpenHandler A handler to be called when opening the popover

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Constructor Summary

Constructors

Constructor and Description
Popover(elemental2.dom.HTMLElement target, String title, elemental2.dom.Node content)

Method Summary

Modifier and Type	Method and Description
Popover	addCloseListener(Popover.CloseHandler closeHandler) Adds a close handler to be called when the popover is closed
Popover	addOpenListener(Popover.OpenHandler openHandler) Adds an open handler to be called when the popover is opened
void	close() Closes the popover
Popover	closeOnEscape(boolean closeOnEscape) Sets if the popover should be closed if escape key is pressed
Popover	closeOnEscp(boolean closeOnEscp) Deprecated.
Popover	closeOnScroll(boolean closeOnScroll) Sets if the popover should be closed if scrolling
static Popover	create(elemental2.dom.HTMLElement target, String title, org.jboss.elemento.IsElement<?> content) Creates new instance for target with title and content
static Popover	create(elemental2.dom.HTMLElement target, String title, elemental2.dom.Node content) Creates new instance for target with title and content
static Popover	create(org.jboss.elemento.IsElement<?> target, String title, org.jboss.elemento.IsElement<?> content) Creates new instance for target with title and content
static Popover	create(org.jboss.elemento.IsElement<?> target, String title, elemental2.dom.Node content) Creates new instance for target with title and content
static Popover	createPicker(elemental2.dom.HTMLElement target, elemental2.dom.Node content) Creates new instance hidden and with no paddings by default; this is helpful for pickers inside TimeBox and DateBox
static Popover	createPicker(org.jboss.elemento.IsElement<?> target, org.jboss.elemento.IsElement<?> content) Same as createPicker(HTMLElement, Node) but with wrapper IsElement
Popover	disable()
void	discard() Closes the popover and remove it completely from the target element so it will not be shown again
elemental2.dom.HTMLDivElement	element()
Popover	enable()
DominoElement<elemental2.dom.HTMLDivElement>	getContentElement()
elemental2.dom.Text	getHeaderText()
DominoElement<elemental2.dom.HTMLHeadingElement>	getHeadingElement()
boolean	isCloseOnScroll()
boolean	isEnabled()
Popover	position(PopupPosition position) Sets the position of the popover related to the target element
Popover	removeCloseHandler(Popover.CloseHandler closeHandler) Removes a close handler
Popover	removeOpenHandler(Popover.OpenHandler openHandler) Removes an open handler
Popover	setCloseOthers(boolean closeOthers) Sets if other popovers should be closed when open this one
Popover	show() Show the item if it is hidden

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, elevate, elevate, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

Popover

public Popover(elemental2.dom.HTMLElement target,
               String title,
               elemental2.dom.Node content)

Method Detail

show

public Popover show()

Show the item if it is hidden

Specified by:

show in interface IsCollapsible<Popover>

Overrides:

show in class BaseDominoElement<elemental2.dom.HTMLDivElement,Popover>

Returns:

same component

See Also:

Collapsible.show()

close

public void close()

Closes the popover

discard

public void discard()

Closes the popover and remove it completely from the target element so it will not be shown again

createPicker

public static Popover createPicker(elemental2.dom.HTMLElement target,
                                   elemental2.dom.Node content)

Creates new instance hidden and with no paddings by default; this is helpful for pickers inside TimeBox and DateBox

Parameters:

target - the target element

content - the Node content

Returns:

new instance

createPicker

public static Popover createPicker(org.jboss.elemento.IsElement<?> target,
                                   org.jboss.elemento.IsElement<?> content)

Same as createPicker(HTMLElement, Node) but with wrapper IsElement

Parameters:

target - the target element

content - the IsElement content

Returns:

new instance

create

public static Popover create(elemental2.dom.HTMLElement target,
                             String title,
                             elemental2.dom.Node content)

Creates new instance for target with title and content

Parameters:

target - the target element

title - the title of the popover

content - the content Node

Returns:

new instance

create

public static Popover create(elemental2.dom.HTMLElement target,
                             String title,
                             org.jboss.elemento.IsElement<?> content)

Creates new instance for target with title and content

Parameters:

target - the target element

title - the title of the popover

content - the content Node

Returns:

new instance

create

public static Popover create(org.jboss.elemento.IsElement<?> target,
                             String title,
                             elemental2.dom.Node content)

Creates new instance for target with title and content

Parameters:

target - the target element

title - the title of the popover

content - the content Node

Returns:

new instance

create

public static Popover create(org.jboss.elemento.IsElement<?> target,
                             String title,
                             org.jboss.elemento.IsElement<?> content)

Creates new instance for target with title and content

Parameters:

target - the target element

title - the title of the popover

content - the content IsElement

Returns:

new instance

position

public Popover position(PopupPosition position)

Sets the position of the popover related to the target element

Parameters:

position - the PopupPosition

Returns:

same instance

setCloseOthers

public Popover setCloseOthers(boolean closeOthers)

Sets if other popovers should be closed when open this one

Parameters:

closeOthers - true to close all popovers when this on is opened, false otherwise

Returns:

same instance

enable

public Popover enable()

Specified by:

enable in interface Switchable<Popover>

Overrides:

enable in class BaseDominoElement<elemental2.dom.HTMLDivElement,Popover>

Returns:

same implementing component

disable

public Popover disable()

Specified by:

disable in interface Switchable<Popover>

Overrides:

disable in class BaseDominoElement<elemental2.dom.HTMLDivElement,Popover>

Returns:

same implementing component

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Switchable<Popover>

Returns:

boolean, true if component is enabled else false

getHeadingElement

public DominoElement<elemental2.dom.HTMLHeadingElement> getHeadingElement()

Returns:

The heading element

closeOnEscp

@Deprecated
public Popover closeOnEscp(boolean closeOnEscp)

Deprecated.

Use closeOnEscape(boolean) instead

closeOnEscape

public Popover closeOnEscape(boolean closeOnEscape)

Sets if the popover should be closed if escape key is pressed

Parameters:

closeOnEscape - true to close on escape, false otherwise

Returns:

same instance

closeOnScroll

public Popover closeOnScroll(boolean closeOnScroll)

Sets if the popover should be closed if scrolling

Parameters:

closeOnScroll - true to close on scroll, false otherwise

Returns:

same instance

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,Popover>

Returns:

the HTML element of type E which is the root element of the component

getContentElement

public DominoElement<elemental2.dom.HTMLDivElement> getContentElement()

Returns:

the content element

getHeaderText

public elemental2.dom.Text getHeaderText()

Returns:

The header text

isCloseOnScroll

public boolean isCloseOnScroll()

Returns:

true if close on scrolling, false otherwise

addOpenListener

public Popover addOpenListener(Popover.OpenHandler openHandler)

Adds an open handler to be called when the popover is opened

Parameters:

openHandler - the Popover.OpenHandler

Returns:

same instance

addCloseListener

public Popover addCloseListener(Popover.CloseHandler closeHandler)

Adds a close handler to be called when the popover is closed

Parameters:

closeHandler - the Popover.CloseHandler

Returns:

same instance

removeOpenHandler

public Popover removeOpenHandler(Popover.OpenHandler openHandler)

Removes an open handler

Parameters:

openHandler - the Popover.OpenHandler to remove

Returns:

same instance

removeCloseHandler

public Popover removeCloseHandler(Popover.CloseHandler closeHandler)

Removes a close handler

Parameters:

closeHandler - the Popover.CloseHandler to remove

Returns:

same instance