jb.gwt_main_modules.base_widgets.client.js_api

Class MessageApiPublisher

java.lang.Object

jb.gwt_main_modules.base_widgets.client.js_api.MessageApiPublisher

public class MessageApiPublisher
extends java.lang.Object

Publishes the API for communicating with users via alerts, dialogs, or notifications.

All methods are located in a sub object at window.MBAPI.message

(window.MBAPI.message.showAlert(theHeader, theBody) for example)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageApiPublisher.MessageTypes

Constructor Summary

Constructors

Constructor and Description
MessageApiPublisher()

Method Summary

Modifier and Type	Method and Description
static void	clearAllNotifications() Clear any active notifications currently displayed in the notification center for my user
static void	createPlaceholderAsset() show the new asset dialog
static void	setupAPI() Initialize the message API namespace object.
static void	setupJavascriptAPIs() Setup message javascript API.
static void	showAlert(java.lang.String theHeader, java.lang.String theBody) Show a standard (non-blocking) alert dialog like MediaBeacon would
static jb.gwt_main_modules.base_widgets.client.message.ApiPopupDialog	showDialog(java.lang.String theDialogTitle, java.lang.Object theDialogContent, java.lang.String thePosText, java.lang.String theNegText, com.google.gwt.core.client.JavaScriptObject thePosAction, com.google.gwt.core.client.JavaScriptObject theNegAction, java.lang.String theContentHeight, java.lang.String theContentWidth, boolean theDontShow, boolean theIsCustom) Show a dialog.
static void	showNotificationDialog(java.lang.String theDialogTitle, java.lang.String theDialogContent, java.lang.String theContentHeight, java.lang.String theContentWidth, com.google.gwt.core.client.JavaScriptObject theButtonAction) Show a notification dialog with an "OK" button.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageApiPublisher

public MessageApiPublisher()

Method Detail

setupJavascriptAPIs

public static void setupJavascriptAPIs()

Setup message javascript API.

setupAPI

public static void setupAPI()

Initialize the message API namespace object.

clearAllNotifications

public static void clearAllNotifications()

Clear any active notifications currently displayed in the notification center for my user

showAlert

public static void showAlert(java.lang.String theHeader,
                             java.lang.String theBody)

Show a standard (non-blocking) alert dialog like MediaBeacon would

Parameters:

theHeader - Text to display in header

theBody - text to display in body

showDialog

public static jb.gwt_main_modules.base_widgets.client.message.ApiPopupDialog showDialog(java.lang.String theDialogTitle,
                                                                                        java.lang.Object theDialogContent,
                                                                                        java.lang.String thePosText,
                                                                                        java.lang.String theNegText,
                                                                                        com.google.gwt.core.client.JavaScriptObject thePosAction,
                                                                                        com.google.gwt.core.client.JavaScriptObject theNegAction,
                                                                                        java.lang.String theContentHeight,
                                                                                        java.lang.String theContentWidth,
                                                                                        boolean theDontShow,
                                                                                        boolean theIsCustom)

Show a dialog.

Parameters:

theDialogTitle - The dialog title.

theDialogContent - The dialog content, can be either a javascript element object or a string.

thePosText - The positive button text.

theNegText - The negative button text.

thePosAction - The positive button action.

theNegAction - The negative button action.

theContentHeight - The height of the content of the dialog, should be a string that includes CSS units (e.g. "10px", "1em")

theContentWidth - The width of the content of the dialog, should be a string that includes CSS units (e.g. "10px", "1em")

theDontShow - Don't show the dialog, just construct it?

theIsCustom - Do not apply standard styling

Returns:

The dialog.

createPlaceholderAsset

public static void createPlaceholderAsset()

show the new asset dialog

showNotificationDialog

public static void showNotificationDialog(java.lang.String theDialogTitle,
                                          java.lang.String theDialogContent,
                                          java.lang.String theContentHeight,
                                          java.lang.String theContentWidth,
                                          com.google.gwt.core.client.JavaScriptObject theButtonAction)

Show a notification dialog with an "OK" button.

Parameters:

theDialogTitle - The dialog title. (Can be empty.)

theDialogContent - The dialog content. (Plain text or HTML.)

theContentHeight - The height

theContentWidth - The width

theButtonAction - The button action.