org.gwtbootstrap3.extras.bootbox.client

Class Bootbox

Object

Bootbox

public class Bootbox
extends Object

Bootbox.js is a small JavaScript library which allows you to create programmatic dialog boxes using Bootstrap modals.

Author:

Xiaodong Sun

See Also:

http://bootboxjs.com/

Constructor Summary

Constructors

Constructor and Description
Bootbox()

Method Summary

Modifier and Type	Method and Description
static void	alert(AlertOptions options) Displays a customized alert with the given AlertOptions.
static void	alert(String msg) Displays a message in a modal dialog box.
static void	alert(String msg, SimpleCallback callback) Displays a message in a modal dialog box.
static void	confirm(ConfirmOptions options) Displays a customized confirm with the given ConfirmOptions.
static void	confirm(String msg, ConfirmCallback callback) Displays a message in a modal dialog box, along with the standard 'OK' and 'Cancel' buttons.
static void	dialog(DialogOptions options) Displays a completely customizable dialog in a modal dialog box.
static void	hideAll() Hide all currently active bootbox dialogs.
static void	init(SimpleCallback callback) Sets a callback when dialog gets initialized.
static void	prompt(PromptOptions options) Displays a customized prompt with the given PromptOptions.
static void	prompt(String msg, PromptCallback callback) Displays a request for information in a modal dialog box, along with the standard 'OK' and 'Cancel' buttons.
static void	setDefaults(DialogOptions options) Set many of the default options shown in the dialog example. Many of these options are also applied to the basic wrapper methods and can be overridden whenever the wrapper methods are invoked with a single options argument.
static void	setLocale(BootboxLocale locale) Sets a locale.

Methods inherited from class Object

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

Constructor Detail

Bootbox

public Bootbox()

Method Detail

alert

public static void alert(String msg)

Displays a message in a modal dialog box.

Parameters:

msg - the message to be displayed.

alert

public static void alert(String msg,
                         SimpleCallback callback)

Displays a message in a modal dialog box. With callback handler.

Parameters:

msg - the message to be displayed.

callback - the callback handler.

alert

public static void alert(AlertOptions options)

Displays a customized alert with the given AlertOptions.

Parameters:

options -

confirm

public static void confirm(String msg,
                           ConfirmCallback callback)

Displays a message in a modal dialog box, along with the standard 'OK' and 'Cancel' buttons.

Parameters:

msg - the message to be displayed.

callback - the callback handler.

confirm

public static void confirm(ConfirmOptions options)

Displays a customized confirm with the given ConfirmOptions.

Parameters:

options -

prompt

public static void prompt(String msg,
                          PromptCallback callback)

Displays a request for information in a modal dialog box, along with the standard 'OK' and 'Cancel' buttons.

Parameters:

msg - the message to be displayed.

callback - the callback handler.

prompt

public static void prompt(PromptOptions options)

Displays a customized prompt with the given PromptOptions.

Parameters:

options -

dialog

public static void dialog(DialogOptions options)

Displays a completely customizable dialog in a modal dialog box.

Parameters:

options - the dialog options.

init

public static void init(SimpleCallback callback)

Sets a callback when dialog gets initialized.

Parameters:

callback -

setDefaults

public static void setDefaults(DialogOptions options)

Set many of the default options shown in the dialog example.

Many of these options are also applied to the basic wrapper methods and can be overridden whenever the wrapper methods are invoked with a single options argument.

Parameters:

options -

setLocale

public static void setLocale(BootboxLocale locale)

Sets a locale.

Parameters:

locale - if null, defaults to BootboxLocale.EN.

hideAll

public static void hideAll()

Hide all currently active bootbox dialogs.

Individual dialogs can be closed as per normal Bootstrap dialogs: dialog.modal('hide').