com.helger.bootstrap3.modal

Class BootstrapModal

java.lang.Object

com.helger.bootstrap3.modal.BootstrapModal

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.html.hc.IHCNodeBuilder

public class BootstrapModal
extends Object
implements com.helger.html.hc.IHCNodeBuilder, com.helger.commons.id.IHasID<String>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_FADE
static boolean	DEFAULT_SHOW_CLOSE
static String	JS_EVENT_HIDDEN
static String	JS_EVENT_HIDE
static String	JS_EVENT_LOADED
static String	JS_EVENT_SHOW
static String	JS_EVENT_SHOWN

Constructor Summary

Constructors

Constructor and Description
BootstrapModal()
BootstrapModal(EBootstrapModalSize eSize)

Method Summary

Methods

Modifier and Type	Method and Description
com.helger.html.hc.html.HCDiv	build()
String	getID()
EBootstrapModalSize	getSize()
boolean	isFade()
boolean	isShowClose()
com.helger.html.js.builder.JSInvocation	jsModal()
com.helger.html.js.builder.JSInvocation	jsModalHide() Manually hides a modal.
com.helger.html.js.builder.JSInvocation	jsModalShow() Manually opens a modal.
com.helger.html.js.builder.JSInvocation	jsModalToggle() Manually toggles a modal.
com.helger.html.js.builder.JSPackage	openModal(EBootstrapModalOptionBackdrop aBackdrop, Boolean aKeyboard, Boolean aShow, String sRemotePath) Activates your content as a modal.
BootstrapModal	setBody(com.helger.html.hc.IHCNode... aFooter)
BootstrapModal	setBody(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(String sFooter)
BootstrapModal	setHeader(com.helger.html.hc.IHCNode... aFooter)
BootstrapModal	setHeader(com.helger.html.hc.IHCNode aHeader)
BootstrapModal	setHeader(String sHeader)
BootstrapModal	setShowClose(boolean bShowClose)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FADE

public static final boolean DEFAULT_FADE

See Also:

Constant Field Values

DEFAULT_SHOW_CLOSE

public static final boolean DEFAULT_SHOW_CLOSE

See Also:

Constant Field Values

JS_EVENT_SHOW

public static final String JS_EVENT_SHOW

See Also:

Constant Field Values

JS_EVENT_SHOWN

public static final String JS_EVENT_SHOWN

See Also:

Constant Field Values

JS_EVENT_HIDE

public static final String JS_EVENT_HIDE

See Also:

Constant Field Values

JS_EVENT_HIDDEN

public static final String JS_EVENT_HIDDEN

See Also:

Constant Field Values

JS_EVENT_LOADED

public static final String JS_EVENT_LOADED

See Also:

Constant Field Values

Constructor Detail

BootstrapModal

public BootstrapModal()

BootstrapModal

public BootstrapModal(@Nonnull
              EBootstrapModalSize eSize)

Method Detail

getID

@Nonnull
@Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getSize

@Nonnull
public EBootstrapModalSize getSize()

isFade

public boolean isFade()

setFade

@Nonnull
public BootstrapModal setFade(boolean bFade)

isShowClose

public boolean isShowClose()

setShowClose

@Nonnull
public BootstrapModal setShowClose(boolean bShowClose)

setHeader

@Nonnull
public BootstrapModal setHeader(@Nullable
                               String sHeader)

setHeader

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

setHeader

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

setBody

@Nonnull
public BootstrapModal setBody(@Nullable
                             String sBody)

setBody

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

setBody

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

setFooter

@Nonnull
public BootstrapModal setFooter(@Nullable
                               String sFooter)

setFooter

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

setFooter

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

build

@Nullable
public com.helger.html.hc.html.HCDiv build()

Specified by:

build in interface com.helger.html.hc.IHCNodeBuilder

jsModal

@Nonnull
public com.helger.html.js.builder.JSInvocation jsModal()

Returns:

JS invocation to open this modal dialog.

openModal

@Nonnull
public com.helger.html.js.builder.JSPackage openModal(@Nullable
                                                     EBootstrapModalOptionBackdrop aBackdrop,
                                                     @Nullable
                                                     Boolean aKeyboard,
                                                     @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

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.js.builder.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.js.builder.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.js.builder.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