org.gwtbootstrap3.extras.growl.client.ui
Class Growl

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      org.gwtbootstrap3.extras.growl.client.ui.Growl

public class Growl
extends JavaScriptObject

This class represent instance of displayed Growl.

You can display new Growl using static methods, e.g.: growl(String), growl(String, GrowlType), growl(String, GrowlOptions) and others

To further configure Growl before displaying see: GrowlOptions

You can update displayed Growl by: updateTitle(String), updateMessage(String), updateIcon(String), updateType(GrowlType),

You can hide displayed Growl: hide(), hideAll(), hideAll(GrowlPosition)

Author:

jeffisenhart, Sven Jacobs, Joshua Godi, Pavel Zlámal

Constructor Summary

protected

Growl()

Method Summary

static Growl	growl(String message) Display Growl with custom message and default settings.
static Growl	growl(String message, GrowlOptions options) Display Growl with custom message and custom settings.
static Growl	growl(String message, GrowlType type) Display Growl with custom message, type and default settings.
static Growl	growl(String title, String message) Display Growl with custom title, message and default settings.
static Growl	growl(String title, String message, GrowlOptions options) Display Growl with custom title, message and custom settings.
static Growl	growl(String title, String message, GrowlType type) Display Growl with custom title, message, type and default settings.
static Growl	growl(String title, String message, org.gwtbootstrap3.client.ui.constants.IconType iconType) Display Growl with custom title, message, icon and default settings.
static Growl	growl(String title, String message, org.gwtbootstrap3.client.ui.constants.IconType iconType, GrowlOptions options) Display Growl with custom title, message, icon and custom settings.
static Growl	growl(String title, String message, org.gwtbootstrap3.client.ui.constants.IconType iconType, GrowlType type) Display Growl with custom title, message, icon, type and default settings.
static Growl	growl(String title, String message, org.gwtbootstrap3.client.ui.constants.IconType iconType, String url) Display Growl with custom title, message, icon, url and default settings.
static Growl	growl(String title, String message, org.gwtbootstrap3.client.ui.constants.IconType iconType, String url, GrowlOptions options) Display Growl with custom title, message, icon, URL and custom settings.
static Growl	growl(String title, String message, org.gwtbootstrap3.client.ui.constants.IconType iconType, String url, GrowlType type) Display Growl with custom title, message, icon, url, type and default settings.
static Growl	growl(String title, String message, String icon) Display Growl with custom title, message, icon and default settings.
static Growl	growl(String title, String message, String icon, GrowlOptions options) Display Growl with custom title, message, icon and custom settings.
static Growl	growl(String title, String message, String icon, GrowlType type) Display Growl with custom title, message, icon, type and default settings.
static Growl	growl(String title, String message, String icon, String url) Display Growl with custom title, message, icon and default settings.
static Growl	growl(String title, String message, String icon, String url, GrowlOptions options) Display Growl with custom title, message, icon, URL and custom settings.
static Growl	growl(String title, String message, String icon, String url, GrowlType type) Display Growl with custom title, message, icon, url, type and default settings.
void	hide() Hide this Growl.
static void	hideAll() Hide all displayed Growls.
static void	hideAll(GrowlPosition position) Hide all displayed Growls on specific screen location.
void	updateIcon(org.gwtbootstrap3.client.ui.constants.IconType type) Updates Icon parameter of once displayed Growl.
void	updateIcon(String icon) Updates Icon parameter of once displayed Growl.
void	updateMessage(String message) Updates message parameter of once displayed Growl.
void	updateTitle(String title) Updates title parameter of once displayed Growl.
void	updateType(GrowlType type) Update type of once displayed Growl (CSS style class name).

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Growl

protected Growl()

Method Detail

growl

public static final Growl growl(String message)

Display Growl with custom message and default settings.

Parameters:

message - Message to set

Returns:

Displayed Growl for update or hiding.

growl

public static final Growl growl(String title,
                                String message)

Display Growl with custom title, message and default settings.

Parameters:

title - Title to set

message - Message to set

Returns:

Displayed Growl for update or hiding.

growl

public static final Growl growl(String title,
                                String message,
                                String icon)

Display Growl with custom title, message, icon and default settings.

Parameters:

title - Title to set

message - Message to set

icon - Icon to set

Returns:

Displayed Growl for update or hiding.

growl

public static final Growl growl(String title,
                                String message,
                                org.gwtbootstrap3.client.ui.constants.IconType iconType)

Display Growl with custom title, message, icon and default settings.

Parameters:

title - Title to set

message - Message to set

iconType - IconType to set

Returns:

Displayed Growl for update or hiding.

growl

public static final Growl growl(String title,
                                String message,
                                String icon,
                                String url)

Display Growl with custom title, message, icon and default settings.

Parameters:

title - Title to set

message - Message to set

icon - IconType to set

url - Url to set

Returns:

Displayed Growl for update or hiding.

growl

public static final Growl growl(String title,
                                String message,
                                org.gwtbootstrap3.client.ui.constants.IconType iconType,
                                String url)

Display Growl with custom title, message, icon, url and default settings.

Parameters:

title - Title to set

message - Message to set

iconType - IconType to set

url - Url to set

Returns:

Displayed Growl for update or hiding.

growl

public static final Growl growl(String message,
                                GrowlType type)

Display Growl with custom message, type and default settings.

Parameters:

message - Message to set

type - GrowlType

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlType

growl

public static final Growl growl(String title,
                                String message,
                                GrowlType type)

Display Growl with custom title, message, type and default settings.

Parameters:

title - Title to set

message - Message to set

type - GrowlType

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlType

growl

public static final Growl growl(String title,
                                String message,
                                String icon,
                                GrowlType type)

Display Growl with custom title, message, icon, type and default settings.

Parameters:

title - Title to set

message - Message to set

icon - Icon to set

type - GrowlType

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlType

growl

public static final Growl growl(String title,
                                String message,
                                org.gwtbootstrap3.client.ui.constants.IconType iconType,
                                GrowlType type)

Display Growl with custom title, message, icon, type and default settings.

Parameters:

title - Title to set

message - Message to set

iconType - IconType to set (css name of icon form FONT AWESOME)

type - GrowlType

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlType

growl

public static final Growl growl(String title,
                                String message,
                                String icon,
                                String url,
                                GrowlType type)

Display Growl with custom title, message, icon, url, type and default settings.

Parameters:

title - Title to set

message - Message to set

icon - Icon to set

url - Url to set

type - GrowlType

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlType

growl

public static final Growl growl(String title,
                                String message,
                                org.gwtbootstrap3.client.ui.constants.IconType iconType,
                                String url,
                                GrowlType type)

Display Growl with custom title, message, icon, url, type and default settings.

Parameters:

title - Title to set

message - Message to set

iconType - IconType to set (css name of icon form FONT AWESOME)

url - Url to set

type - GrowlType

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlType

growl

public static final Growl growl(String message,
                                GrowlOptions options)

Display Growl with custom message and custom settings.

Parameters:

message - Message to set

options - custom options

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlOptions

growl

public static final Growl growl(String title,
                                String message,
                                GrowlOptions options)

Display Growl with custom title, message and custom settings.

Parameters:

title - Title to set

message - Message to set

options - custom options

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlOptions

growl

public static final Growl growl(String title,
                                String message,
                                String icon,
                                GrowlOptions options)

Display Growl with custom title, message, icon and custom settings.

Parameters:

title - Title to set

message - Message to set

icon - Icon to set

options - custom options

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlOptions

growl

public static final Growl growl(String title,
                                String message,
                                org.gwtbootstrap3.client.ui.constants.IconType iconType,
                                GrowlOptions options)

Display Growl with custom title, message, icon and custom settings.

Parameters:

title - Title to set

message - Message to set

iconType - IconType to set (css name of icon form FONT AWESOME)

options - custom options

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlOptions

growl

public static final Growl growl(String title,
                                String message,
                                String icon,
                                String url,
                                GrowlOptions options)

Display Growl with custom title, message, icon, URL and custom settings.

Parameters:

title - Title to set

message - Message to set

icon - Icon to set

url - Url to set

options - custom options

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlOptions

growl

public static final Growl growl(String title,
                                String message,
                                org.gwtbootstrap3.client.ui.constants.IconType iconType,
                                String url,
                                GrowlOptions options)

Display Growl with custom title, message, icon, URL and custom settings.

Parameters:

title - Title to set

message - Message to set

iconType - IconType to set

url - Url to set

options - custom options

Returns:

Displayed Growl for update or hiding.

See Also:

GrowlOptions

hideAll

public static final void hideAll()

Hide all displayed Growls.

hideAll

public static final void hideAll(GrowlPosition position)

Hide all displayed Growls on specific screen location.

Parameters:

position - Growls position on screen.

See Also:

GrowlPosition

updateTitle

public final void updateTitle(String title)

Updates title parameter of once displayed Growl.

Parameters:

title - Title to set

updateMessage

public final void updateMessage(String message)

Updates message parameter of once displayed Growl.

Parameters:

message - Message to set

updateIcon

public final void updateIcon(String icon)

Updates Icon parameter of once displayed Growl.

Parameters:

icon - Icon to set

updateIcon

public final void updateIcon(org.gwtbootstrap3.client.ui.constants.IconType type)

Updates Icon parameter of once displayed Growl. This method is shortcut when using FONT AWESOME iconic font.

Parameters:

type - IconType to get CSS class name to set

updateType

public final void updateType(GrowlType type)

Update type of once displayed Growl (CSS style class name).

Parameters:

type - one of INFO, WARNING, DANGER, SUCCESS

See Also:

GrowlType

hide

public final void hide()

Hide this Growl.