com.google.appinventor.components.runtime

Class Notifier

java.lang.Object

com.google.appinventor.components.runtime.AndroidNonvisibleComponent

com.google.appinventor.components.runtime.Notifier

All Implemented Interfaces:

Component

public final class Notifier
extends AndroidNonvisibleComponent
implements Component

The Notifier component displays alert messages and creates Android log entries through the following methods:

• ShowMessageDialog: user must dismiss the message by pressing a button.
• ShowChooseDialog: displays two buttons to let the user choose one of two responses, for example, yes or no, after which the AfterChoosing event is raised.
• ShowTextDialog: lets the user enter text in response to the message, after which the AfterTextInput event is raised.
• ShowAlert: displays an alert that goes away by itself after a short time.
• ShowProgressDialog: displays an alert with a loading spinner that cannot be dismissed by the user. Can only be dismissed by using the DismissProgressDialog block.
• DismissProgressDialog: Dismisses the progress dialog displayed by ShowProgressDialog.
• LogError: logs an error message to the Android log.
• LogInfo: logs an info message to the Android log.
• LogWarning: logs a warning message to the Android log.

Field Summary

Fields inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

form

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Constructor and Description
Notifier(ComponentContainer container) Creates a new Notifier component.

Method Summary

Methods

Modifier and Type	Method and Description
void	AfterChoosing(java.lang.String choice) Event after the user has made a selection for ShowChooseDialog.
void	AfterTextInput(java.lang.String response) Event raised after the user has responded to ShowTextDialog.
void	BackgroundColor(int argb) Specifies the alert's background color.
void	DismissProgressDialog() Dismisses the alert created by the ShowProgressDialog block
void	HideKeyboard(android.view.View view) Hide soft keyboard after user either enters text or cancels.
void	LogError(java.lang.String message) Log an error message.
void	LogInfo(java.lang.String message) Log an information message.
void	LogWarning(java.lang.String message) Log a warning message.
int	NotifierLength()
void	NotifierLength(int length) Specifies the length of time that the alert is shown -- either "short" or "long".
static void	oneButtonAlert(android.app.Activity activity, java.lang.String message, java.lang.String title, java.lang.String buttonText)
void	progressDialog(java.lang.String message, java.lang.String title) This method creates the actual ProgressDialog.
void	ShowAlert(java.lang.String notice) Display a temporary notification
void	ShowChooseDialog(java.lang.String message, java.lang.String title, java.lang.String button1Text, java.lang.String button2Text, boolean cancelable) Displays an alert with two buttons that have specified text.
void	ShowMessageDialog(java.lang.String message, java.lang.String title, java.lang.String buttonText) Display an alert dialog with a single button that dismisses the alert.
void	ShowProgressDialog(java.lang.String message, java.lang.String title) Display a progress dialog that cannot be dismissed by the user.
void	ShowTextDialog(java.lang.String message, java.lang.String title, boolean cancelable) Shows a dialog box in which the user can enter text, after which the AfterTextInput event is raised.
int	TextColor() Returns the alert's text color.
void	TextColor(int argb) Specifies the alert's text color.
static void	twoButtonDialog(android.app.Activity activity, java.lang.String message, java.lang.String title, java.lang.String button1Text, java.lang.String button2Text, boolean cancelable, java.lang.Runnable positiveAction, java.lang.Runnable negativeAction, java.lang.Runnable cancelAction)

Methods inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

getDispatchDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.appinventor.components.runtime.Component

getDispatchDelegate

Constructor Detail

Notifier

public Notifier(ComponentContainer container)

Creates a new Notifier component.

Parameters:

container - the enclosing component

Method Detail

ShowProgressDialog

public void ShowProgressDialog(java.lang.String message,
                      java.lang.String title)

Display a progress dialog that cannot be dismissed by the user. To dismiss this alert, you must use the DismissProgressDialog block

Parameters:

message - the text in the alert box

title - the title for the alert box

DismissProgressDialog

public void DismissProgressDialog()

Dismisses the alert created by the ShowProgressDialog block

progressDialog

public void progressDialog(java.lang.String message,
                  java.lang.String title)

This method creates the actual ProgressDialog. If one is already being displayed, then it dismisses it, and creates this new one.

Parameters:

message - the message for the dialog

title - the title for the dialog

ShowMessageDialog

public void ShowMessageDialog(java.lang.String message,
                     java.lang.String title,
                     java.lang.String buttonText)

Display an alert dialog with a single button that dismisses the alert.

Parameters:

message - the text in the alert box

title - the title for the alert box

buttonText - the text on the button

oneButtonAlert

public static void oneButtonAlert(android.app.Activity activity,
                  java.lang.String message,
                  java.lang.String title,
                  java.lang.String buttonText)

ShowChooseDialog

public void ShowChooseDialog(java.lang.String message,
                    java.lang.String title,
                    java.lang.String button1Text,
                    java.lang.String button2Text,
                    boolean cancelable)

Displays an alert with two buttons that have specified text. If cancelable is true, there is an additional button marked CANCEL that cancels the dialog. Raises the AfterChoosing event when the choice has been made, and returns the text of the button that was pressed.

Parameters:

message - the text in the alert box

title - the title for the alert box

button1Text - the text on the left-hand button

button2Text - the text on the right-hand button

cancelable - indicates if additional CANCEL button should be added

twoButtonDialog

public static void twoButtonDialog(android.app.Activity activity,
                   java.lang.String message,
                   java.lang.String title,
                   java.lang.String button1Text,
                   java.lang.String button2Text,
                   boolean cancelable,
                   java.lang.Runnable positiveAction,
                   java.lang.Runnable negativeAction,
                   java.lang.Runnable cancelAction)

AfterChoosing

public void AfterChoosing(java.lang.String choice)

Event after the user has made a selection for ShowChooseDialog.

Parameters:

choice - is the text on the button the user pressed

ShowTextDialog

public void ShowTextDialog(java.lang.String message,
                  java.lang.String title,
                  boolean cancelable)

Shows a dialog box in which the user can enter text, after which the AfterTextInput event is raised.

Parameters:

message - the text in the alert box

title - the title for the alert box

cancelable - indicates whether the user should be able to cancel out of dialog. When true, an additional CANCEL button will be added allowing user to cancel out of dialog. If selected, it will raise AfterTextInput with text of CANCEL.

HideKeyboard

public void HideKeyboard(android.view.View view)

Hide soft keyboard after user either enters text or cancels.

AfterTextInput

public void AfterTextInput(java.lang.String response)

Event raised after the user has responded to ShowTextDialog.

Parameters:

response - is the text that was entered

ShowAlert

public void ShowAlert(java.lang.String notice)

Display a temporary notification

Parameters:

notice - the text of the notification

NotifierLength

public void NotifierLength(int length)

Specifies the length of time that the alert is shown -- either "short" or "long".

Parameters:

length - Length of time that an alert is visible

NotifierLength

public int NotifierLength()

BackgroundColor

public void BackgroundColor(int argb)

Specifies the alert's background color.

Parameters:

argb - background RGB color with alpha

TextColor

public int TextColor()

Returns the alert's text color.

Returns:

text RGB color with alpha

TextColor

public void TextColor(int argb)

Specifies the alert's text color.

Parameters:

argb - text RGB color with alpha

LogError

public void LogError(java.lang.String message)

Log an error message.

Parameters:

message - the error message

LogWarning

public void LogWarning(java.lang.String message)

Log a warning message.

Parameters:

message - the warning message

LogInfo

public void LogInfo(java.lang.String message)

Log an information message.

Parameters:

message - the information message