org.gwtbootstrap3.extras.bootbox.client.options

Class DialogOptions

Object

JavaScriptObject

DialogOptions

Direct Known Subclasses:

AlertOptions, ConfirmOptions, PromptOptions

public class DialogOptions
extends JavaScriptObject

Bootbox dialog options.

Author:

Xiaodong Sun

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DialogOptions()

Method Summary

Modifier and Type	Method and Description
void	addButton(String label) Adds a custom button.
void	addButton(String label, SimpleCallback callback) Adds a custom button with a callback.
void	addButton(String label, String className) Adds a custom button with a class name.
void	addButton(String label, String className, SimpleCallback callback) Adds a custom button with a class name and a callback.
static DialogOptions	newOptions(String message) Creates a new DialogOptions.
void	setAnimate(boolean animate) Animate the dialog in and out. Defaults to true.
void	setBackdrop(Boolean backdrop) Whether the dialog should have a backdrop or not.
void	setClassName(String className) An additional class to apply to the dialog wrapper. Defaults to true.
void	setCloseButton(boolean closeButton) Whether the dialog should have a close button or not. Defaults to true.
void	setLocale(BootboxLocale locale) The locale settings used to translate the three standard button labels: OK, CONFIRM, CANCEL.
void	setOnEscape(SimpleCallback callback) Allows the user to dismiss the dialog by hitting ESC, which will invoke this function. Defaults to null for custom dialogs.
void	setShow(boolean show) Whether the dialog should be shown immediately. Defaults to true.
void	setSize(BootboxSize size) Adds the relevant Bootstrap modal size class to the dialog wrapper. Defaults to null.
void	setTitle(String title) Adds a header to the dialog and places this text in an H4.

Methods inherited from class JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DialogOptions

protected DialogOptions()

Method Detail

newOptions

public static DialogOptions newOptions(String message)

Creates a new DialogOptions.

Parameters:

message -

Returns:

setTitle

public final void setTitle(String title)

Adds a header to the dialog and places this text in an H4.

Parameters:

title -

setLocale

public final void setLocale(BootboxLocale locale)

The locale settings used to translate the three standard button labels: OK, CONFIRM, CANCEL.

Parameters:

locale -

setOnEscape

public final void setOnEscape(SimpleCallback callback)

Allows the user to dismiss the dialog by hitting ESC, which will invoke this function.

Defaults to null for custom dialogs.

Parameters:

callback -

setShow

public final void setShow(boolean show)

Whether the dialog should be shown immediately.

Defaults to true.

Parameters:

show -

setBackdrop

public final void setBackdrop(Boolean backdrop)

Whether the dialog should have a backdrop or not. Also determines whether clicking on the backdrop dismisses the modal.

• null: The backdrop is displayed, but clicking on it has no effect.
• true: The backdrop is displayed, and clicking on it dismisses the dialog.
• false: The backdrop is not displayed.

Defaults to null.

Parameters:

backdrop -

setCloseButton

public final void setCloseButton(boolean closeButton)

Whether the dialog should have a close button or not.

Defaults to true.

Parameters:

closeButton -

setAnimate

public final void setAnimate(boolean animate)

Animate the dialog in and out.

Defaults to true.

Parameters:

animate -

setClassName

public final void setClassName(String className)

An additional class to apply to the dialog wrapper.

Defaults to true.

Parameters:

className -

setSize

public final void setSize(BootboxSize size)

Adds the relevant Bootstrap modal size class to the dialog wrapper.

Defaults to null.

Parameters:

size -

addButton

public final void addButton(String label)

Adds a custom button.

Parameters:

label -

addButton

public final void addButton(String label,
                            String className)

Adds a custom button with a class name.

Parameters:

label -

className -

addButton

public final void addButton(String label,
                            SimpleCallback callback)

Adds a custom button with a callback.

Parameters:

label -

callback -

addButton

public final void addButton(String label,
                            String className,
                            SimpleCallback callback)

Adds a custom button with a class name and a callback.

Parameters:

label -

className -

callback -