org.gwtbootstrap3.extras.notify.client.ui

Class Notify

Object

JavaScriptObject

Notify

public class Notify
extends JavaScriptObject

This class represent instance of displayed Notify.

You can display new Notify using static methods, e.g.: notify(String), notify(String, NotifyType), notify(String, NotifySettings) and others

To further configure Notify before displaying see: NotifySettings

You can update displayed Notify by: updateTitle(String), updateMessage(String), updateIcon(String), updateType(NotifyType),

You can hide displayed Notify: hide(), hideAll(), hideAll(NotifyPlacement)

Author:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Notify()

Method Summary

Modifier and Type	Method and Description
void	hide() Hide this Notify.
static void	hideAll() Hide all displayed Notifies.
static void	hideAll(NotifyPlacement placement) Hide all displayed Notifies on specific screen location.
static Notify	notify(String message) Display Notify with custom message, and default settings.
static Notify	notify(String message, NotifySettings settings) Display Notify with custom message and custom settings.
static Notify	notify(String message, NotifyType type) Display Notify with custom message, type and default settings.
static Notify	notify(String title, String message) Display Notify with custom title, message, and default settings.
static Notify	notify(String title, String message, IconType iconType) Display Notify with custom title, message, icon, and default settings.
static Notify	notify(String title, String message, IconType iconType, NotifySettings settings) Display Notify with custom title, message, icon and custom settings.
static Notify	notify(String title, String message, IconType iconType, NotifyType type) Display Notify with custom title, message, icon, type and default settings.
static Notify	notify(String title, String message, IconType iconType, String url) Display Notify with custom title, message, icon, url and default settings.
static Notify	notify(String title, String message, IconType iconType, String url, NotifySettings settings) Display Notify with custom title, message, icon, URL and custom settings.
static Notify	notify(String title, String message, IconType iconType, String url, NotifyType type) Display Notify with custom title, message, icon, url, type and default settings.
static Notify	notify(String title, String message, NotifySettings settings) Display Notify with custom title, message and custom settings.
static Notify	notify(String title, String message, NotifyType type) Display Notify with custom title, message, type and default settings.
static Notify	notify(String title, String message, String icon) Display Notify with custom title, message, icon, and default settings.
static Notify	notify(String title, String message, String icon, NotifySettings settings) Display Notify with custom title, message, icon and custom settings.
static Notify	notify(String title, String message, String icon, NotifyType type) Display Notify with custom title, message, icon, type and default settings.
static Notify	notify(String title, String message, String icon, String url) Display Notify with custom title, message, icon, URL, and default settings.
static Notify	notify(String title, String message, String icon, String url, NotifySettings settings) Display Notify with custom title, message, icon, URL and custom settings.
static Notify	notify(String title, String message, String icon, String url, NotifyType type) Display Notify with custom title, message, icon, url, type and default settings.
void	updateIcon(IconType type) Updates Icon parameter of once displayed Notify.
void	updateIcon(String icon) Updates Icon parameter of once displayed Notify.
void	updateMessage(String message) Updates message parameter of once displayed Notify.
void	updateTitle(String title) Updates title parameter of once displayed Notify.
void	updateType(NotifyType type) Update type of once displayed Notify (CSS style class name).

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

Notify

protected Notify()

Method Detail

notify

public static final Notify notify(String message)

Display Notify with custom message, and default settings.

Parameters:

message - Message to set

Returns:

Displayed Notify for update or hiding.

notify

public static final Notify notify(String title,
                                  String message)

Display Notify with custom title, message, and default settings.

Parameters:

title - Title to set

message - Message to set

Returns:

Displayed Notify for update or hiding.

notify

public static final Notify notify(String title,
                                  String message,
                                  String icon)

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

Parameters:

title - Title to set

message - Message to set

icon - Icon to set

Returns:

Displayed Notify for update or hiding.

notify

public static final Notify notify(String title,
                                  String message,
                                  IconType iconType)

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

Parameters:

title - Title to set

message - Message to set

iconType - IconType to set

Returns:

Displayed Notify for update or hiding.

notify

public static final Notify notify(String title,
                                  String message,
                                  String icon,
                                  String url)

Display Notify with custom title, message, icon, URL, and default settings.

Parameters:

title - Title to set

message - Message to set

icon - IconType to set

url - Url to set

Returns:

Displayed Notify for update or hiding.

notify

public static final Notify notify(String title,
                                  String message,
                                  IconType iconType,
                                  String url)

Display Notify 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 Notify for update or hiding.

notify

public static final Notify notify(String message,
                                  NotifyType type)

Display Notify with custom message, type and default settings.

Parameters:

message - Message to set

type - NotifyType

Returns:

Displayed Notify for update or hiding.

See Also:

NotifyType

notify

public static final Notify notify(String title,
                                  String message,
                                  NotifyType type)

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

Parameters:

title - Title to set

message - Message to set

type - NotifyType

Returns:

Displayed Notify for update or hiding.

See Also:

NotifyType

notify

public static final Notify notify(String title,
                                  String message,
                                  String icon,
                                  NotifyType type)

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

Parameters:

title - Title to set

message - Message to set

icon - Icon to set

type - NotifyType

Returns:

Displayed Notify for update or hiding.

See Also:

NotifyType

notify

public static final Notify notify(String title,
                                  String message,
                                  IconType iconType,
                                  NotifyType type)

Display Notify 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 - NotifyType

Returns:

Displayed Notify for update or hiding.

See Also:

NotifyType

notify

public static final Notify notify(String title,
                                  String message,
                                  String icon,
                                  String url,
                                  NotifyType type)

Display Notify 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 - NotifyType

Returns:

Displayed Notify for update or hiding.

See Also:

NotifyType

notify

public static final Notify notify(String title,
                                  String message,
                                  IconType iconType,
                                  String url,
                                  NotifyType type)

Display Notify 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 - NotifyType

Returns:

Displayed Notify for update or hiding.

See Also:

NotifyType

notify

public static final Notify notify(String message,
                                  NotifySettings settings)

Display Notify with custom message and custom settings.

Parameters:

message - Message to set

settings - custom settings

Returns:

Displayed Notify for update or hiding.

See Also:

NotifySettings

notify

public static final Notify notify(String title,
                                  String message,
                                  NotifySettings settings)

Display Notify with custom title, message and custom settings.

Parameters:

title - Title to set

message - Message to set

settings - custom settings

Returns:

Displayed Notify for update or hiding.

See Also:

NotifySettings

notify

public static final Notify notify(String title,
                                  String message,
                                  String icon,
                                  NotifySettings settings)

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

Parameters:

title - Title to set

message - Message to set

icon - Icon to set

settings - custom settings

Returns:

Displayed Notify for update or hiding.

See Also:

NotifySettings

notify

public static final Notify notify(String title,
                                  String message,
                                  IconType iconType,
                                  NotifySettings settings)

Display Notify 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)

settings - custom settings

Returns:

Displayed Notify for update or hiding.

See Also:

NotifySettings

notify

public static final Notify notify(String title,
                                  String message,
                                  String icon,
                                  String url,
                                  NotifySettings settings)

Display Notify 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

settings - custom settings

Returns:

Displayed Notify for update or hiding.

See Also:

NotifySettings

notify

public static final Notify notify(String title,
                                  String message,
                                  IconType iconType,
                                  String url,
                                  NotifySettings settings)

Display Notify 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

settings - custom settings

Returns:

Displayed Notify for update or hiding.

See Also:

NotifySettings

hideAll

public static final void hideAll()

Hide all displayed Notifies.

hideAll

public static final void hideAll(NotifyPlacement placement)

Hide all displayed Notifies on specific screen location.

Parameters:

placement - Notify's placement on screen.

See Also:

NotifyPlacement

updateTitle

public final void updateTitle(String title)

Updates title parameter of once displayed Notify.

Parameters:

title - Title to set

updateMessage

public final void updateMessage(String message)

Updates message parameter of once displayed Notify.

Parameters:

message - Message to set

updateIcon

public final void updateIcon(String icon)

Updates Icon parameter of once displayed Notify.

Parameters:

icon - Icon to set

updateIcon

public final void updateIcon(IconType type)

Updates Icon parameter of once displayed Notify. 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(NotifyType type)

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

Parameters:

type - one of INFO, WARNING, DANGER, SUCCESS

See Also:

NotifyType

hide

public final void hide()

Hide this Notify.