org.dominokit.domino.ui.modals

Class BaseModal<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

java.lang.Object

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

org.dominokit.domino.ui.modals.BaseModal<T>

Type Parameters:

T - the type of the component extending from this class

All Implemented Interfaces:

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

Direct Known Subclasses:

ConfirmationDialog, MessageDialog, ModalDialog, Window

public abstract class BaseModal<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>
extends BaseDominoElement<elemental2.dom.HTMLDivElement,T>
implements IsModalDialog<T>, Switchable<T>

A base implementaton for components to show a pop-up

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseModal.Modal a component that contains the modal elements

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

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.modals.IsModalDialog

IsModalDialog.CloseHandler, IsModalDialog.ModalSize, IsModalDialog.ModalType, IsModalDialog.OpenHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseModal.Modal	modalElement

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

element

Constructor Summary

Constructors

Constructor and Description
BaseModal()
BaseModal(String title)

Method Summary

Modifier and Type	Method and Description
T	addCloseListener(IsModalDialog.CloseHandler closeHandler)
T	addOpenListener(IsModalDialog.OpenHandler openHandler)
T	appendChild(org.jboss.elemento.IsElement<?> content) Appends to the Modal body
T	appendChild(elemental2.dom.Node content) Appends to the Modal body
T	appendFooterChild(org.jboss.elemento.IsElement<?> content)
T	appendFooterChild(elemental2.dom.Node content) Appends to the Modal body
T	centerVertically() make the dialog show up in the center of the screen
T	close() Close and hide the dialog
T	deCenterVertically() make the dialog show up on the top of the screen
T	disable()
elemental2.dom.HTMLDivElement	element()
T	enable()
boolean	getAutoAppendAndRemove()
DominoElement<elemental2.dom.HTMLDivElement>	getBodyElement()
DominoElement<elemental2.dom.HTMLDivElement>	getContentElement()
DominoElement<elemental2.dom.HTMLDivElement>	getDialogElement()
DominoElement<elemental2.dom.HTMLDivElement>	getFooterElement()
DominoElement<elemental2.dom.HTMLDivElement>	getHeaderContainerElement()
DominoElement<elemental2.dom.HTMLHeadingElement>	getHeaderElement()
T	hideFooter() Hides the footer of the dialog
T	hideHeader() hide the header of the dialog
T	hideTitle() Hide the title of the dialog
boolean	isAutoClose()
boolean	isAutoFocus()
boolean	isEnabled()
boolean	isModal()
boolean	isOpen()
T	large() set the dialog size to IsModalDialog.ModalSize.LARGE
T	open() Show the dialog
T	removeCloseHandler(IsModalDialog.CloseHandler closeHandler)
T	removeOpenHandler(IsModalDialog.OpenHandler openHandler)
T	setAutoAppendAndRemove(boolean autoAppendAndRemove)
T	setAutoClose(boolean autoClose)
T	setAutoFocus(boolean autoFocus)
T	setModal(boolean modal)
T	setModalColor(Color color)
T	setSize(IsModalDialog.ModalSize size)
T	setTitle(String title)
T	setType(IsModalDialog.ModalType type)
T	showFooter() Show the footer of the dialog
T	showHeader() Show the header of the dialog
T	showTitle() Show the title of the dialog
T	small() set the dialog size to IsModalDialog.ModalSize.SMALL

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

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, 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, show, 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

Field Detail

modalElement

protected BaseModal.Modal modalElement

Constructor Detail

BaseModal

public BaseModal()

BaseModal

public BaseModal(String title)

Parameters:

title - String modal header title

Method Detail

appendChild

public T appendChild(elemental2.dom.Node content)

Appends to the Modal body

Specified by:

appendChild in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Specified by:

appendChild in interface HasChildren<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

content - Node to be appended to the component

Returns:

same component

appendChild

public T appendChild(org.jboss.elemento.IsElement<?> content)

Appends to the Modal body

Specified by:

appendChild in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Specified by:

appendChild in interface HasChildren<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

content - IsElement to be appended to the component

Returns:

same component

appendFooterChild

public T appendFooterChild(elemental2.dom.Node content)

Appends to the Modal body

Specified by:

appendFooterChild in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

content - Node to be appended to the modal footer

Returns:

same implementing component

appendFooterChild

public T appendFooterChild(org.jboss.elemento.IsElement<?> content)

Specified by:

appendFooterChild in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

content - IsElement to be appended to the modal footer

Returns:

same implementing component

large

public T large()

set the dialog size to IsModalDialog.ModalSize.LARGE

Specified by:

large in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing interface

small

public T small()

set the dialog size to IsModalDialog.ModalSize.SMALL

Specified by:

small in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing interface

setSize

public T setSize(IsModalDialog.ModalSize size)

Parameters:

size - IsModalDialog.ModalSize

Returns:

same Dialog instance

setType

public T setType(IsModalDialog.ModalType type)

Parameters:

type - IsModalDialog.ModalType

Returns:

same dialog instance

setModalColor

public T setModalColor(Color color)

Specified by:

setModalColor in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

color - Color of the modal header and body

Returns:

same implementing interface

setAutoClose

public T setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

autoClose - boolean, true to close the dialog by pressing escape key

Returns:

same implementing interface

open

public T open()

Show the dialog

Specified by:

open in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

close

public T close()

Close and hide the dialog

Specified by:

close in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

isAutoClose

public boolean isAutoClose()

Returns:

boolean

See Also:

setAutoClose(boolean)

hideFooter

public T hideFooter()

Hides the footer of the dialog

Specified by:

hideFooter in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

showFooter

public T showFooter()

Show the footer of the dialog

Specified by:

showFooter in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

hideHeader

public T hideHeader()

hide the header of the dialog

Specified by:

hideHeader in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

showHeader

public T showHeader()

Show the header of the dialog

Specified by:

showHeader in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

hideTitle

public T hideTitle()

Hide the title of the dialog

Specified by:

hideTitle in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

showTitle

public T showTitle()

Show the title of the dialog

Specified by:

showTitle in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

setTitle

public T setTitle(String title)

Specified by:

setTitle in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

title - String

Returns:

same implementing component

getDialogElement

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

Specified by:

getDialogElement in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

getContentElement

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

Specified by:

getContentElement in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

getHeaderElement

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

Specified by:

getHeaderElement in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

getHeaderContainerElement

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

Specified by:

getHeaderContainerElement in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

getBodyElement

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

Specified by:

getBodyElement in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

getFooterElement

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

Specified by:

getFooterElement in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

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,T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

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

addOpenListener

public T addOpenListener(IsModalDialog.OpenHandler openHandler)

Specified by:

addOpenListener in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

openHandler - IsModalDialog.OpenHandler

Returns:

same implementing component

addCloseListener

public T addCloseListener(IsModalDialog.CloseHandler closeHandler)

Specified by:

addCloseListener in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

closeHandler - IsModalDialog.CloseHandler

Returns:

same implementing component

removeOpenHandler

public T removeOpenHandler(IsModalDialog.OpenHandler openHandler)

Specified by:

removeOpenHandler in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

openHandler - IsModalDialog.OpenHandler

Returns:

same implementing component

removeCloseHandler

public T removeCloseHandler(IsModalDialog.CloseHandler closeHandler)

Specified by:

removeCloseHandler in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

closeHandler - IsModalDialog.CloseHandler

Returns:

same implementing component

isOpen

public boolean isOpen()

Returns:

boolean, true if the modal is currently open

enable

public T enable()

Specified by:

enable in interface Switchable<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Overrides:

enable in class BaseDominoElement<elemental2.dom.HTMLDivElement,T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

disable

public T disable()

Specified by:

disable in interface Switchable<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Overrides:

disable in class BaseDominoElement<elemental2.dom.HTMLDivElement,T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Switchable<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

boolean, true if component is enabled else false

setAutoAppendAndRemove

public T setAutoAppendAndRemove(boolean autoAppendAndRemove)

Specified by:

setAutoAppendAndRemove in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

autoAppendAndRemove - boolean, true to automatically remove and append the modal every time we open it

Returns:

same implementing component

centerVertically

public T centerVertically()

make the dialog show up in the center of the screen

Specified by:

centerVertically in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

same implementing component

deCenterVertically

public T deCenterVertically()

make the dialog show up on the top of the screen

Specified by:

deCenterVertically in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

getAutoAppendAndRemove

public boolean getAutoAppendAndRemove()

Specified by:

getAutoAppendAndRemove in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

boolean, true to automatically remove and append the modal every time we open it

isModal

public boolean isModal()

Returns:

boolean, true if this modal will show an overlay to block the content behind it.

setModal

public T setModal(boolean modal)

Parameters:

modal - boolean,true to make this modal show an overlay to block the content behind it when it is open

Returns:

same dialog instance

isAutoFocus

public boolean isAutoFocus()

Specified by:

isAutoFocus in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Returns:

boolean, true if the modal should auto-focus first focusable element when opened.

setAutoFocus

public T setAutoFocus(boolean autoFocus)

Specified by:

setAutoFocus in interface IsModalDialog<T extends org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>>

Parameters:

autoFocus - boolean, true if the modal should auto-focus first focusable element when opened.

Returns:

same dialog instance