com.helger.photon.bootstrap4.modal

Class BootstrapModal

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.html.AbstractHCElement<IMPLTYPE>

com.helger.html.hc.html.AbstractHCElementWithInternalChildren<IMPLTYPE,com.helger.html.hc.IHCNode>

com.helger.html.hc.html.AbstractHCElementWithChildren<IMPLTYPE>

com.helger.html.hc.html.grouping.AbstractHCDiv<BootstrapModal>

com.helger.photon.bootstrap4.modal.BootstrapModal

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<com.helger.html.hc.IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<com.helger.html.hc.IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<com.helger.html.hc.IHCNode>, com.helger.commons.traits.IGenericImplTrait<BootstrapModal>, com.helger.html.hc.html.grouping.IHCDiv<BootstrapModal>, com.helger.html.hc.html.IHCElement<BootstrapModal>, com.helger.html.hc.html.IHCElementWithChildren<BootstrapModal>, com.helger.html.hc.html.IHCElementWithInternalChildren<BootstrapModal,com.helger.html.hc.IHCNode>, com.helger.html.hc.html.IHCHasCSSClasses<BootstrapModal>, com.helger.html.hc.html.IHCHasCSSStyles<BootstrapModal>, com.helger.html.hc.IHCHasChildrenMutable<BootstrapModal,com.helger.html.hc.IHCNode>, com.helger.html.hc.IHCHasID<BootstrapModal>, com.helger.html.hc.IHCHasName<BootstrapModal>, com.helger.html.hc.IHCNode, com.helger.html.hc.IHCNodeWithChildren<BootstrapModal>, Serializable

public class BootstrapModal
extends com.helger.html.hc.html.grouping.AbstractHCDiv<BootstrapModal>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_FADE
static boolean	DEFAULT_SCROLL_BODY
static boolean	DEFAULT_SHOW_CLOSE
static boolean	DEFAULT_VERTICALLY_CENTERED
static String	JS_EVENT_HIDDEN This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
static String	JS_EVENT_HIDE This event is fired immediately when the hide instance method has been called.
static String	JS_EVENT_LOADED This event is fired when the modal has loaded content using the remote option.
static String	JS_EVENT_SHOW This event fires immediately when the show instance method is called.
static String	JS_EVENT_SHOWN This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete).

Fields inherited from class com.helger.html.hc.html.AbstractHCElement

DEFAULT_HIDDEN, DEFAULT_SPELLCHECK, DEFAULT_TRANSLATE, DEFAULT_UNFOCUSABLE

Fields inherited from interface com.helger.html.hc.html.IHCElement

DEFAULT_TABINDEX

Constructor Summary

Constructors

Constructor and Description
BootstrapModal()
BootstrapModal(EBootstrapModalSize eSize)

Method Summary

Modifier and Type	Method and Description
EBootstrapModalSize	getSize()
boolean	isFade()
boolean	isScrollBody()
boolean	isShowClose()
boolean	isVerticallyCentered()
com.helger.html.jscode.JSInvocation	jsModal()
com.helger.html.jscode.JSInvocation	jsModalDispose()
com.helger.html.jscode.JSInvocation	jsModalHandleUpdate() Readjusts the modal's positioning to counter a scrollbar in case one should appear, which would make the modal jump to the left.
com.helger.html.jscode.JSInvocation	jsModalHide() Manually hides a modal.
com.helger.html.jscode.JSInvocation	jsModalShow() Manually opens a modal.
com.helger.html.jscode.JSInvocation	jsModalToggle() Manually toggles a modal.
protected void	onFinalizeNodeState(com.helger.html.hc.IHCConversionSettingsToNode aConversionSettings, com.helger.html.hc.IHCHasChildrenMutable<?,? super com.helger.html.hc.IHCNode> aTargetNode)
com.helger.html.jscode.JSPackage	openModal(EBootstrapModalOptionBackdrop aBackdrop, Boolean aKeyboard, Boolean aFocus, Boolean aShow, String sRemotePath) Activates your content as a modal.
BootstrapModal	setBody(com.helger.html.hc.IHCNode... aBody)
BootstrapModal	setBody(com.helger.html.hc.IHCNode aBody)
BootstrapModal	setBody(Iterable<? extends com.helger.html.hc.IHCNode> aBody)
BootstrapModal	setBody(String sBody)
BootstrapModal	setFade(boolean bFade)
BootstrapModal	setFooter(com.helger.html.hc.IHCNode... aFooter)
BootstrapModal	setFooter(com.helger.html.hc.IHCNode aFooter)
BootstrapModal	setFooter(Iterable<? extends com.helger.html.hc.IHCNode> aFooter)
BootstrapModal	setFooter(String sFooter)
BootstrapModal	setHeader(com.helger.html.hc.IHCNode... aHeader)
BootstrapModal	setHeader(com.helger.html.hc.IHCNode aHeader)
BootstrapModal	setHeader(Iterable<? extends com.helger.html.hc.IHCNode> aHeader)
BootstrapModal	setHeader(String sHeader)
BootstrapModal	setScrollBody(boolean bScrollBody)
BootstrapModal	setShowClose(boolean bShowClose)
BootstrapModal	setSize(EBootstrapModalSize eSize)
BootstrapModal	setVerticallyCentered(boolean bVerticallyCentered)

Methods inherited from class com.helger.html.hc.html.grouping.AbstractHCDiv

fillMicroElement, getName, setName, toString

Methods inherited from class com.helger.html.hc.html.AbstractHCElementWithInternalChildren

addChild, addChildAt, afterAddChild, afterRemoveChild, beforeAddChild, canConvertToMicroNode, children, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getAllChildrenAsNodeList, getChildAtIndex, getChildCount, getChildren, getChildrenFormEmitting, getFirstChild, getLastChild, getPlainText, hasChildren, removeAllChildren, removeChild, removeChildAt, sortAllChildren

Methods inherited from class com.helger.html.hc.html.AbstractHCElement

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, finishMicroElement, getAccessKey, getAllClasses, getAllClassesAsString, getAllClassNames, getAllStyles, getAllStylesAsString, getAllStyleValues, getContentEditable, getContextMenu, getDirection, getDraggable, getDropZone, getElement, getEventHandler, getEventMap, getID, getLanguage, getRole, getStyleValue, getTabIndex, getTagName, getTitle, getTranslate, hasAnyClass, hasAnyStyle, hasStyle, internalConvertToMicroNode, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, isValidID, onConsistencyCheck, prependEventHandler, removeAllClasses, removeAllEventHandler, removeAllStyles, removeClass, removeStyle, setAccessKey, setContentEditable, setContextMenu, setDirection, setDraggable, setDropZone, setEventHandler, setHidden, setID, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setUnfocusable

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, internalSetNodeState, onCustomizeNode, onRegisterExternalResources, registerExternalResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.html.hc.html.IHCElementWithInternalChildren

recursiveContainsChildWithTagName

Methods inherited from interface com.helger.html.hc.html.IHCElement

addEventHandler, containsEventHandler, customAttrs, getAccessKey, getContentEditable, getContextMenu, getDirection, getDraggable, getDropZone, getElement, getEventHandler, getEventMap, getLanguage, getRole, getTabIndex, getTagName, getTitle, getTranslate, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, setAccessKey, setContentEditable, setContextMenu, setDirection, setDraggable, setDropZone, setEventHandler, setHidden, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable

Methods inherited from interface com.helger.html.hc.IHCHasID

ensureID, getID, hasID, hasNoID, setID, setUniqueID

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSStyles

addStyle, addStyle, addStyles, addStyles, addStyles, containsStyle, getAllStyles, getAllStylesAsString, getAllStyleValues, getStyleValue, hasAnyStyle, hasStyle, removeAllStyles, removeStyle

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSClasses

addClass, addClasses, addClasses, addClasses, containsClass, getAllClasses, getAllClassesAsString, getAllClassNames, hasAnyClass, removeAllClasses, removeClass

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.html.hc.IHCNodeWithChildren

addChild, addChildAt, addChildren, addChildren, setChild

Methods inherited from interface com.helger.html.hc.IHCHasChildrenMutable

addAndReturnChild, addAndReturnChildAt, addChild, addChildAt, addChildren, addChildren, addChildren, addChildrenAt, addChildrenAt, getAllChildrenAsNodeList, removeAllChildren, removeChild, removeChildAt, setChild, sortAllChildren

Methods inherited from interface com.helger.html.hc.IHCNode

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

findFirstChild, findFirstChildMapped, getAllChildren, getChildAtIndex, getFirstChild, getLastChild

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

Field Detail

JS_EVENT_SHOW

public static final String JS_EVENT_SHOW

This event fires immediately when the show instance method is called. If caused by a click, the clicked element is available as the relatedTarget property of the event.

See Also:

Constant Field Values

JS_EVENT_SHOWN

public static final String JS_EVENT_SHOWN

This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the relatedTarget property of the event.

See Also:

Constant Field Values

JS_EVENT_HIDE

public static final String JS_EVENT_HIDE

This event is fired immediately when the hide instance method has been called.

See Also:

Constant Field Values

JS_EVENT_HIDDEN

public static final String JS_EVENT_HIDDEN

This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).

See Also:

Constant Field Values

JS_EVENT_LOADED

public static final String JS_EVENT_LOADED

This event is fired when the modal has loaded content using the remote option.

See Also:

Constant Field Values

DEFAULT_FADE

public static final boolean DEFAULT_FADE

See Also:

Constant Field Values

DEFAULT_VERTICALLY_CENTERED

public static final boolean DEFAULT_VERTICALLY_CENTERED

See Also:

Constant Field Values

DEFAULT_SCROLL_BODY

public static final boolean DEFAULT_SCROLL_BODY

See Also:

Constant Field Values

DEFAULT_SHOW_CLOSE

public static final boolean DEFAULT_SHOW_CLOSE

See Also:

Constant Field Values

Constructor Detail

BootstrapModal

public BootstrapModal()

BootstrapModal

public BootstrapModal(@Nonnull
                      EBootstrapModalSize eSize)

Method Detail

getSize

@Nonnull
public final EBootstrapModalSize getSize()

setSize

@Nonnull
public final BootstrapModal setSize(@Nonnull
                                              EBootstrapModalSize eSize)

isFade

public final boolean isFade()

setFade

@Nonnull
public final BootstrapModal setFade(boolean bFade)

isVerticallyCentered

public final boolean isVerticallyCentered()

setVerticallyCentered

@Nonnull
public final BootstrapModal setVerticallyCentered(boolean bVerticallyCentered)

isScrollBody

public final boolean isScrollBody()

setScrollBody

@Nonnull
public final BootstrapModal setScrollBody(boolean bScrollBody)

isShowClose

public final boolean isShowClose()

setShowClose

@Nonnull
public final BootstrapModal setShowClose(boolean bShowClose)

setHeader

@Nonnull
public final BootstrapModal setHeader(@Nullable
                                                String sHeader)

setHeader

@Nonnull
public final BootstrapModal setHeader(@Nullable
                                                com.helger.html.hc.IHCNode aHeader)

setHeader

@Nonnull
public final BootstrapModal setHeader(@Nullable
                                                com.helger.html.hc.IHCNode... aHeader)

setHeader

@Nonnull
public final BootstrapModal setHeader(@Nullable
                                                Iterable<? extends com.helger.html.hc.IHCNode> aHeader)

setBody

@Nonnull
public final BootstrapModal setBody(@Nullable
                                              String sBody)

setBody

@Nonnull
public final BootstrapModal setBody(@Nullable
                                              com.helger.html.hc.IHCNode aBody)

setBody

@Nonnull
public final BootstrapModal setBody(@Nullable
                                              com.helger.html.hc.IHCNode... aBody)

setBody

@Nonnull
public final BootstrapModal setBody(@Nullable
                                              Iterable<? extends com.helger.html.hc.IHCNode> aBody)

setFooter

@Nonnull
public final BootstrapModal setFooter(@Nullable
                                                String sFooter)

setFooter

@Nonnull
public final BootstrapModal setFooter(@Nullable
                                                com.helger.html.hc.IHCNode aFooter)

setFooter

@Nonnull
public final BootstrapModal setFooter(@Nullable
                                                com.helger.html.hc.IHCNode... aFooter)

setFooter

@Nonnull
public final BootstrapModal setFooter(@Nullable
                                                Iterable<? extends com.helger.html.hc.IHCNode> aFooter)

onFinalizeNodeState

protected void onFinalizeNodeState(@Nonnull
                                   com.helger.html.hc.IHCConversionSettingsToNode aConversionSettings,
                                   @Nonnull
                                   com.helger.html.hc.IHCHasChildrenMutable<?,? super com.helger.html.hc.IHCNode> aTargetNode)

Overrides:

onFinalizeNodeState in class com.helger.html.hc.html.AbstractHCElement<BootstrapModal>

jsModal

@Nonnull
public com.helger.html.jscode.JSInvocation jsModal()

Returns:

JS invocation to open this modal dialog.

openModal

@Nonnull
public com.helger.html.jscode.JSPackage openModal(@Nullable
                                                            EBootstrapModalOptionBackdrop aBackdrop,
                                                            @Nullable
                                                            Boolean aKeyboard,
                                                            @Nullable
                                                            Boolean aFocus,
                                                            @Nullable
                                                            Boolean aShow,
                                                            @Nullable
                                                            String sRemotePath)

Activates your content as a modal. Accepts an optional options object.

Parameters:

aBackdrop - Includes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.

aKeyboard - Closes the modal when escape key is pressed

aFocus - Puts the focus on the modal when initialized.

aShow - Shows the modal when initialized.

sRemotePath - If a remote URL is provided, content will be loaded one time via jQuery's load method and injected into the .modal-content div.

Returns:

JS invocation to open this modal dialog with the specified options.

jsModalToggle

@Nonnull
public com.helger.html.jscode.JSInvocation jsModalToggle()

Manually toggles a modal. Returns to the caller before the modal has actually been shown or hidden (i.e. before the shown.bs.modal or hidden.bs.modal event occurs).

Returns:

JS invocation

jsModalShow

@Nonnull
public com.helger.html.jscode.JSInvocation jsModalShow()

Manually opens a modal. Returns to the caller before the modal has actually been shown (i.e. before the shown.bs.modal event occurs).

Returns:

JS invocation

jsModalHide

@Nonnull
public com.helger.html.jscode.JSInvocation jsModalHide()

Manually hides a modal. Returns to the caller before the modal has actually been hidden (i.e. before the hidden.bs.modal event occurs).

Returns:

JS invocation

jsModalHandleUpdate

@Nonnull
public com.helger.html.jscode.JSInvocation jsModalHandleUpdate()

Readjusts the modal's positioning to counter a scrollbar in case one should appear, which would make the modal jump to the left. Only needed when the height of the modal changes while it is open.

Returns:

JS invocation

jsModalDispose

@Nonnull
public com.helger.html.jscode.JSInvocation jsModalDispose()