org.dominokit.domino.ui.modals

Class ModalBackDrop

java.lang.Object

org.dominokit.domino.ui.modals.ModalBackDrop

public class ModalBackDrop
extends Object

A utility class to show overlays that blocks the content behind a modal dialog.

this class can track the overlay across the page and all opened modals and it adjust its position whenever a modal is opened or closed

Field Summary

Fields

Modifier and Type	Field and Description
static int	INCREMENT the z-index increment for every modal open
static elemental2.dom.HTMLDivElement	INSTANCE The single instance of the overlay backdrop element

Constructor Summary

Constructors

Constructor and Description
ModalBackDrop()

Method Summary

Modifier and Type	Method and Description
static boolean	allOpenedNotModals()
static void	closePopovers() Close all currently open Popovers
static boolean	contains(BaseModal modal)
static boolean	contains(Popover popover)
static Integer	getNextZIndex()
static void	onScrollClosePopovers() Automatically close all Popovers when the page is scrolled
static int	openedModalsCount()
static void	popModal(BaseModal modal)
static void	popPopOver() remove the popover on top of queue from the tracked modals and to increment the overlay z-index
static void	push(BaseModal modal)
static void	push(Popover popover)
static void	showHideBodyScrolls()
static void	toNextZIndex() Increment the z-index by the INCREMENT

Methods inherited from class java.lang.Object

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

Field Detail

INCREMENT

public static final int INCREMENT

the z-index increment for every modal open

See Also:

Constant Field Values

INSTANCE

public static final elemental2.dom.HTMLDivElement INSTANCE

The single instance of the overlay backdrop element

Constructor Detail

ModalBackDrop

public ModalBackDrop()

Method Detail

contains

public static boolean contains(BaseModal modal)

Parameters:

modal - BaseModal

Returns:

boolean, true if the provided modal is tracked by the ModalBackDrop

push

public static void push(BaseModal modal)

popModal

public static void popModal(BaseModal modal)

Parameters:

modal - BaseModal to be removed from the tracked modals and to increment the overlay z-index

contains

public static boolean contains(Popover popover)

Parameters:

popover - Popover

Returns:

boolean, true if the provided Popover is tracked by the ModalBackDrop

push

public static void push(Popover popover)

Parameters:

popover - Popover to be tracked by this ModalBackDrop and to increment the overlay z-index

popPopOver

public static void popPopOver()

remove the popover on top of queue from the tracked modals and to increment the overlay z-index

getNextZIndex

public static Integer getNextZIndex()

Returns:

the Integer z-index for the next modal

toNextZIndex

public static void toNextZIndex()

Increment the z-index by the INCREMENT

closePopovers

public static void closePopovers()

Close all currently open Popovers

onScrollClosePopovers

public static void onScrollClosePopovers()

Automatically close all Popovers when the page is scrolled

openedModalsCount

public static int openedModalsCount()

Returns:

the int count of all opened moal dialogs

allOpenedNotModals

public static boolean allOpenedNotModals()

Returns:

boolean true if all opened dialogs are not modals

showHideBodyScrolls

public static void showHideBodyScrolls()