com.smartgwt.mobile.client.util

Class SC

java.lang.Object

com.smartgwt.mobile.client.util.SC

public class SC
extends java.lang.Object

Various utility methods.

Constructor Summary

Constructors

Constructor and Description
SC()

Method Summary

Modifier and Type	Method and Description
static boolean	_getPromptAnimationsEnabled()
static void	_maybeInit()
static void	ask(java.lang.String message, BooleanCallback callback) Show a modal dialog with a message, possibly an icon, and "Yes" and "No" buttons.
static void	ask(java.lang.String title, java.lang.String message, BooleanCallback callback) Show a modal dialog with a message, possibly an icon, and "Yes" and "No" buttons.
static void	askforValue(java.lang.String title, java.lang.String message, ValueCallback callback) Show a modal dialog with a text entry box, asking the user to enter a value.
static void	askforValue(java.lang.String message, ValueCallback callback) Show a modal dialog with a text entry box, asking the user to enter a value.
static void	clearPrompt() Clear the modal prompt being shown to the user.
static void	confirm(java.lang.String message, BooleanCallback callback) Show a modal dialog with a message, possibly an icon, and "OK" and "Cancel" buttons.
static void	confirm(java.lang.String title, java.lang.String message, BooleanCallback callback) Show a modal dialog with a message, possibly an icon, and "OK" and "Cancel" buttons.
static void	enablePromptAnimations(java.lang.Boolean enablePromptAnimations) Sets whether to enable or disable showing/hiding animations on built-in prompt/say/warn dialogs.
static void	logEcho(java.lang.Object value)
static void	logEcho(java.lang.Object value, java.lang.String message)
static void	logWarn(java.lang.String message)
static void	logWarn(java.lang.String message, java.lang.String category)
static void	say(java.lang.String message) Show a modal dialog with a message, possibly an icon, and "OK" button.
static void	say(java.lang.String message, BooleanCallback callback) Show a modal dialog with a message, possibly an icon, and "OK" button.
static void	say(java.lang.String title, java.lang.String message) Show a modal dialog with a message, possibly an icon, and "OK" button.
static void	say(java.lang.String title, java.lang.String message, BooleanCallback callback) Show a modal dialog with a message, possibly an icon, and "OK" button.
static void	showPrompt(java.lang.String message) Show a modal prompt to the user.
static void	showPrompt(java.lang.String title, java.lang.String message)
static void	warn(java.lang.String message) Show a modal dialog with a message, possibly an icon, and "OK" button.
static void	warn(java.lang.String message, BooleanCallback callback) Show a modal dialog with a message, possibly an icon, and "OK" button.

Methods inherited from class java.lang.Object

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

Constructor Detail

SC

public SC()

Method Detail

_maybeInit

@SGWTInternal
public static void _maybeInit()

_getPromptAnimationsEnabled

@SGWTInternal
public static boolean _getPromptAnimationsEnabled()

enablePromptAnimations

public static void enablePromptAnimations(java.lang.Boolean enablePromptAnimations)

Sets whether to enable or disable showing/hiding animations on built-in prompt/say/warn dialogs. Changes to this setting take effect with subsequent calls to say(), ask(), confirm(), warn(), showPrompt(), and clearPrompt().

Parameters:

enablePromptAnimations - whether to enable or disable animations. If true or null, then built-in prompt animations are enabled. Default value: null.

say

public static void say(java.lang.String message)

Show a modal dialog with a message, possibly an icon, and "OK" button. Intended for notifications which are not really warnings (default icon is less severe).

Parameters:

message - the message

say

public static void say(java.lang.String title,
                       java.lang.String message)

Show a modal dialog with a message, possibly an icon, and "OK" button. Intended for notifications which are not really warnings (default icon is less severe).

Parameters:

title - the title of the message box

message - the message

say

public static void say(java.lang.String message,
                       BooleanCallback callback)

Show a modal dialog with a message, possibly an icon, and "OK" button. Intended for notifications which are not really warnings (default icon is less severe). The callback will receive boolean true for an OK button click, or null if the Dialog is dismissed via the close button.

Parameters:

message - the message

callback - the callback to fire when the user dismisses the dialog.

say

public static void say(java.lang.String title,
                       java.lang.String message,
                       BooleanCallback callback)

Show a modal dialog with a message, possibly an icon, and "OK" button. Intended for notifications which are not really warnings (default icon is less severe). The callback will receive boolean true for an OK button click, or null if the Dialog is dismissed via the close button.

Parameters:

title - the title of the message box

message - the message

callback - the callback to fire when the user dismisses the dialog.

ask

public static void ask(java.lang.String message,
                       BooleanCallback callback)

Show a modal dialog with a message, possibly an icon, and "Yes" and "No" buttons. The callback will receive boolean true for an OK button click, boolean false for a No button click, or null if the Dialog is dismissed via the close button.

Parameters:

message - the message

callback - the callback to fire when the user dismisses the dialog.

ask

public static void ask(java.lang.String title,
                       java.lang.String message,
                       BooleanCallback callback)

Show a modal dialog with a message, possibly an icon, and "Yes" and "No" buttons. The callback will receive boolean true for an OK button click, boolean false for a No button click, or null if the Dialog is dismissed via the close button.

Parameters:

title - the title of the message box

message - the message

callback - the callback to fire when the user dismisses the dialog.

askforValue

public static void askforValue(java.lang.String message,
                               ValueCallback callback)

Show a modal dialog with a text entry box, asking the user to enter a value.

As with other convenience methods that show Dialogs the dialog is shown and the function immediately returns. When the user responds, the provided callback is called.

If the user clicks OK, the value typed in is passed to the callback (including the empty string ("") if nothing was entered. If the user clicks cancel, the value passed to the callback is null.

A default value for the text field can be passed via properties.defaultValue

Keyboard focus is automatically placed in the text entry field, and hitting the enter key is the equivalent of pressing OK.

Parameters:

message - message to display

callback - Callback to fire when the user clicks a button to dismiss the dialog. This has the single parameter 'value', indicating the user entry, or null if cancel was pressed or the window closed

askforValue

public static void askforValue(java.lang.String title,
                               java.lang.String message,
                               ValueCallback callback)

Show a modal dialog with a text entry box, asking the user to enter a value.

As with other convenience methods that show Dialogs the dialog is shown and the function immediately returns. When the user responds, the provided callback is called.

If the user clicks OK, the value typed in is passed to the callback (including the empty string ("") if nothing was entered. If the user clicks cancel, the value passed to the callback is null.

Keyboard focus is automatically placed in the text entry field, and hitting the enter key is the equivalent of pressing OK.

Parameters:

title - the title of the dialog

message - message to display

callback - Callback to fire when the user clicks a button to dismiss the dialog. This has the single parameter 'value', indicating the user entry, or null if cancel was pressed or the window closed

showPrompt

public static void showPrompt(java.lang.String message)

Show a modal prompt to the user.

Note: If this prompt is to be shown to the user during some slow logic, we advise temporarily disabling prompt animations via SC.enablePromptAnimations(false), calling this method, then using a Timer to kick off the slow logic in a separate thread. In Mobile Safari, the timeout set on the Timer should be more than 1ms (50ms recommended) to give the browser time to repaint the screen. These steps ensure that the prompt is showing before the lengthy execution begins.

Parameters:

message - message to display

See Also:

clearPrompt()

showPrompt

public static void showPrompt(java.lang.String title,
                              java.lang.String message)

clearPrompt

public static void clearPrompt()

Clear the modal prompt being shown to the user.

confirm

public static void confirm(java.lang.String message,
                           BooleanCallback callback)

Show a modal dialog with a message, possibly an icon, and "OK" and "Cancel" buttons.

The callback will receive boolean true for an OK button click, or null for a Cancel click or if the Dialog is dismissed via the close button.

Parameters:

message - message to display

callback - Callback to fire when the user clicks a button to dismiss the dialog.

confirm

public static void confirm(java.lang.String title,
                           java.lang.String message,
                           BooleanCallback callback)

Show a modal dialog with a message, possibly an icon, and "OK" and "Cancel" buttons.

The callback will receive boolean true for an OK button click, or null for a Cancel click or if the Dialog is dismissed via the close button.

Parameters:

title - the title of the dialog

message - message to display

callback - Callback to fire when the user clicks a button to dismiss the dialog.

warn

public static void warn(java.lang.String message)

Show a modal dialog with a message, possibly an icon, and "OK" button.

Parameters:

message - the message

warn

public static void warn(java.lang.String message,
                        BooleanCallback callback)

Show a modal dialog with a message, possibly an icon, and "OK" button.

The callback will receive boolean true for an OK button click, or null if the Dialog is dismissed via the close button.

Parameters:

message - the message

callback - Optional Callback to fire when the user dismisses the dialog.

logEcho

public static void logEcho(java.lang.Object value)

logEcho

public static void logEcho(java.lang.Object value,
                           java.lang.String message)

logWarn

public static void logWarn(java.lang.String message)

logWarn

public static void logWarn(java.lang.String message,
                           java.lang.String category)