com.smartgwt.client.util

## Class SC

- java.lang.Object
- - com.smartgwt.client.util.SC

-     public class SC
      extends java.lang.Object

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static java.lang.String` | `MODULE`
    `static java.lang.String` | `REF`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SC()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static void` | `ask(java.lang.String message, BooleanCallback callback)` Show a modal dialog with a message, 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, icon, and "Yes" and "No" buttons.
    `static void` | `ask(java.lang.String title, java.lang.String message, BooleanCallback callback, Dialog dialogProperties)` Show a modal dialog with a message, icon, and "Yes" and "No" buttons.
    `static void` | `askforValue(java.lang.String title, java.lang.String message, java.lang.String defaultValue, ValueCallback callback, Dialog dialogProperties)` Show a modal dialog with a text entry box, asking the user to enter a value.
    `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, 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, icon, and "OK" and "Cancel" buttons.
    `static void` | `confirm(java.lang.String title, java.lang.String message, BooleanCallback callback, Dialog dialogProperties)` Show a modal dialog with a message, icon, and "OK" and "Cancel" buttons.
    `static void` | `debugger()`
    `static void` | `disableFirebug()` Disable firebug.
    `static java.lang.String` | `echo(com.google.gwt.core.client.JavaScriptObject object)` Returns the passed in JavaScript object as a string
    `static java.lang.String` | `echoAll(com.google.gwt.core.client.JavaScriptObject object)` Returns the passed in JavaScript object as a string (including serializing members one level deep for javascript arrays and nested objects)
    `static java.lang.String` | `generateID()`
    `static java.lang.String` | `generateID(java.lang.String className)`
    `static java.lang.String` | `getHome()`
    `static java.lang.String` | `getLicenseType()`
    `static java.lang.String` | `getSCClassName(com.google.gwt.core.client.JavaScriptObject jsObj)` Gets the name of this underlying SmartClient class as a string.
    `static boolean` | `hasAnalytics()` Returns true is the optional Analytics module has been loaded.
    `static boolean` | `hasCharts()` Returns true is the optional Charts module has been loaded.
    `static boolean` | `hasDrawing()` Returns true is the optional Drawing module has been loaded.
    `static boolean` | `hasFirebug()` Returns `true` if Firebug is enabled.
    `static boolean` | `hasPluginBridges()` Returns true is the optional PluginBridges module has been loaded.
    `static boolean` | `hasRealtimeMessaging()` Returns true is the optional RealtimeMessaging module has been loaded.
    `static boolean` | `isIE()`
    `static void` | `logDebug(java.lang.String message)` Log a debugging.
    `static void` | `logDebug(java.lang.String message, java.lang.String category)` Log a debugging
    `static void` | `logEcho(Canvas canvas)` Logs the echoed object as a warning, prefixed with an optional message.
    `static void` | `logEcho(Canvas canvas, java.lang.String message)` Logs the echoed object as a warning, prefixed with an optional message.
    `static void` | `logEcho(com.google.gwt.core.client.JavaScriptObject value)` Logs the echoed object as a warning, prefixed with an optional message.
    `static void` | `logEcho(com.google.gwt.core.client.JavaScriptObject value, java.lang.String message)` Logs the echoed object as a warning, prefixed with an optional message.
    `static void` | `logEchoAll(Canvas canvas)` Logs the echoed object as a warning, prefixed with an optional message.
    `static void` | `logEchoAll(Canvas canvas, java.lang.String message)` Logs the echoed object as a warning, prefixed with an optional message.
    `static void` | `logEchoAll(com.google.gwt.core.client.JavaScriptObject value)` Logs the echoed object as a warning, prefixed with an optional message.
    `static void` | `logEchoAll(com.google.gwt.core.client.JavaScriptObject value, java.lang.String message)` Logs the echoed object as a warning, prefixed with an optional message.
    `static void` | `logInfo(java.lang.String message)` Log an informative message.
    `static void` | `logInfo(java.lang.String message, java.lang.String category)` Log an informative message.
    `static void` | `logWarn(java.lang.String message)` Log a warning.
    `static void` | `logWarn(java.lang.String message, java.lang.String category)` Log a warning.
    `static void` | `openDataSourceConsole()` Opens the DataSource admin console in a separate window.
    `static void` | `openDataSourceGenerator()` Opens the DataSource Generator Wizard in a separate window.
    `static void` | `openVisualBuilder()` Opens the SmartClient Visual Builder in a separate window.
    `static void` | `releaseID(java.lang.String className, java.lang.String id)`
    `static void` | `say(java.lang.String message)` Show a modal dialog with a message, icon, and "OK" button.
    `static void` | `say(java.lang.String message, BooleanCallback callback)` Show a modal dialog with a message, icon, and "OK" button.
    `static void` | `say(java.lang.String title, java.lang.String message)` Show a modal dialog with a message, icon, and "OK" button.
    `static void` | `say(java.lang.String title, java.lang.String message, BooleanCallback callback)` Show a modal dialog with a message, icon, and "OK" button.
    `static void` | `setEnableJSDebugger(boolean useDebugger)` Setting this to true will result in the IE / Firebug / Safari debugger being invoked when a JavaScript error is encountered.
    `static void` | `setScreenReaderMode(boolean newState)` Enables full screen reader mode.
    `static void` | `showConsole()`
    `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)` Show a modal prompt to the user.
    `static void` | `showPrompt(java.lang.String title, java.lang.String message, Dialog dialogProperties)` Show a modal prompt to the user.
    `static void` | `warn(java.lang.String message)` Show a modal dialog with a message, icon, and "OK" button.
    `static void` | `warn(java.lang.String message, BooleanCallback callback)` Show a modal dialog with a message, icon, and "OK" button.
    `static void` | `warn(java.lang.String title, java.lang.String message)` Show a modal dialog with a message, icon, and "OK" button.
    `static void` | `warn(java.lang.String title, java.lang.String message, BooleanCallback callback, Dialog dialogProperties)` Show a modal dialog with a message, icon, and "OK" button.

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### REF

          public static final java.lang.String REF

      See Also:
        Constant Field Values

    - #### MODULE

          public static final java.lang.String MODULE

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### SC

          public SC()

  - ### Method Detail

    - #### getLicenseType

          public static java.lang.String getLicenseType()

    - #### generateID

          public static java.lang.String generateID()

    - #### generateID

          public static java.lang.String generateID(java.lang.String className)

    - #### releaseID

          public static void releaseID(java.lang.String className,
                       java.lang.String id)

    - #### getHome

          public static java.lang.String getHome()

    - #### debugger

          public static void debugger()

    - #### showConsole

          public static void showConsole()

    - #### openDataSourceConsole

          public static void openDataSourceConsole()

      Opens the DataSource admin console in a separate window.

      Requires Smart GWT Pro or better.

    - #### openVisualBuilder

          public static void openVisualBuilder()

      Opens the SmartClient Visual Builder in a separate window. Note that the Visual Builder is capable of generating DataSources as well, however unlike the DataSource Generator Wizard, it cannot generate DataSources in batches.

      Requires Smart GWT Pro or better.

    - #### openDataSourceGenerator

          public static void openDataSourceGenerator()

      Opens the DataSource Generator Wizard in a separate window.

      Requires Smart GWT Enterprise or Eval.

    - #### getSCClassName

          public static java.lang.String getSCClassName(com.google.gwt.core.client.JavaScriptObject jsObj)

      Gets the name of this underlying SmartClient class as a string.
      Parameters:
        `jsObj` - the smartclient object
      Returns:
        the class name or null if not a smartclient class

    - #### hasFirebug

          public static boolean hasFirebug()

      Returns `true` if Firebug is enabled.
      Returns:
        `true` if Firebug is enabled; `false` otherwise.

    - #### isIE

          public static boolean isIE()

    - #### disableFirebug

          public static void disableFirebug()

      Disable firebug.

    - #### say

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

      Show a modal dialog with a message, 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, 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, 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, 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, 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, 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.

    - #### ask

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

      Show a modal dialog with a message, 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, such as `#warn(String, String, BooleanCallback)` , 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, such as `#warn(String, String, BooleanCallback)` , 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

    - #### askforValue

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

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

      As with other convenience methods that show Dialogs, such as `#warn(String, String, BooleanCallback)` , 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
        `defaultValue` - the default value of the text field
        `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
        `dialogProperties` - additional properties of the Dialog

    - #### showPrompt

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

      Show a modal prompt to the user. This method will display the message using the Dialog.Prompt singleton object.

      Note: if this prompt is to be shown to the user during some slow logic, we advise calling this method, then using `DeferredCommand` to kick off the slow logic in a separate thread. This ensures 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,
                        Dialog dialogProperties)

      Show a modal prompt to the user. This method will display the message using the Dialog.Prompt singleton object.

      Note: if this prompt is to be shown to the user during some slow logic, we advise calling this method, then using `DeferredCommand` to kick off the slow logic in a separate thread. This ensures that the prompt is showing before the lengthy execution begins.

      Parameters:
        `title` - the title of the dialog
        `message` - message to display
        `dialogProperties` - additional properties for the Dialog
      See Also:
        `clearPrompt()`

    - #### showPrompt

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

      Show a modal prompt to the user. This method will display the message using the Dialog.Prompt singleton object.

      Note: if this prompt is to be shown to the user during some slow logic, we advise calling this method, then using `DeferredCommand` to kick off the slow logic in a separate thread. This ensures that the prompt is showing before the lengthy execution begins.

      Parameters:
        `title` - the title of the dialog
        `message` - message to display
      See Also:
        `clearPrompt()`

    - #### 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, 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, 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.

    - #### confirm

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

      Show a modal dialog with a message, 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.
        `dialogProperties` - additional properties for the Dialog

    - #### warn

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

      Show a modal dialog with a message, icon, and "OK" button.
      Parameters:
        `message` - the message

    - #### warn

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

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

      Parameters:
        `title` - the title of the dialog
        `message` - the message

    - #### warn

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

      Show a modal dialog with a message, 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.

    - #### warn

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

      Show a modal dialog with a message, 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:
        `title` - the title of the dialog
        `message` - the message
        `callback` - Optional Callback to fire when the user dismisses the dialog.
        `dialogProperties` - additional properties for the Dialog

    - #### logWarn

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

      Log a warning.
      Parameters:
        `message` - the message to log

    - #### logWarn

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

      Log a warning.
      Parameters:
        `message` - the message to log
        `category` - category to log in, defaults to "Log"

    - #### logInfo

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

      Log an informative message.
      Parameters:
        `message` - the message to log

    - #### logInfo

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

      Log an informative message.
      Parameters:
        `message` - the message to log
        `category` - category to log in, defaults to "Log"

    - #### logDebug

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

      Log a debugging.
      Parameters:
        `message` - the message to log

    - #### logDebug

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

      Log a debugging
      Parameters:
        `message` - the message to log
        `category` - category to log in, defaults to "Log"

    - #### logEcho

          public static void logEcho(com.google.gwt.core.client.JavaScriptObject value)

      Logs the echoed object as a warning, prefixed with an optional message.
      Parameters:
        `value` - object to echo

    - #### logEcho

          public static void logEcho(com.google.gwt.core.client.JavaScriptObject value,
                     java.lang.String message)

      Logs the echoed object as a warning, prefixed with an optional message.
      Parameters:
        `value` - object to echo
        `message` - the message to log

    - #### logEcho

          public static void logEcho(Canvas canvas)

      Logs the echoed object as a warning, prefixed with an optional message.
      Parameters:
        `canvas` - canvas to echo

    - #### logEcho

          public static void logEcho(Canvas canvas,
                     java.lang.String message)

      Logs the echoed object as a warning, prefixed with an optional message.
      Parameters:
        `canvas` - canvas to echo
        `message` - the message to log

    - #### logEchoAll

          public static void logEchoAll(com.google.gwt.core.client.JavaScriptObject value)

      Logs the echoed object as a warning, prefixed with an optional message.
      Parameters:
        `value` - object to echo

    - #### logEchoAll

          public static void logEchoAll(com.google.gwt.core.client.JavaScriptObject value,
                        java.lang.String message)

      Logs the echoed object as a warning, prefixed with an optional message.
      Parameters:
        `value` - object to echo
        `message` - the message to log

    - #### logEchoAll

          public static void logEchoAll(Canvas canvas)

      Logs the echoed object as a warning, prefixed with an optional message.
      Parameters:
        `canvas` - canvas to echo

    - #### setEnableJSDebugger

          public static void setEnableJSDebugger(boolean useDebugger)

      Setting this to true will result in the IE / Firebug / Safari debugger being invoked when a JavaScript error is encountered. This is done by the execution of the commend "debugger;" when the error occurs. Setting this to true is useful for debugging any javascript errors.
      Parameters:
        `useDebugger` - default is false

    - #### logEchoAll

          public static void logEchoAll(Canvas canvas,
                        java.lang.String message)

      Logs the echoed object as a warning, prefixed with an optional message.
      Parameters:
        `canvas` - canvas to echo
        `message` - the message to log

    - #### echo

          public static java.lang.String echo(com.google.gwt.core.client.JavaScriptObject object)

      Returns the passed in JavaScript object as a string
      Parameters:
        `object` -
      Returns:

    - #### echoAll

          public static java.lang.String echoAll(com.google.gwt.core.client.JavaScriptObject object)

      Returns the passed in JavaScript object as a string (including serializing members one level deep for javascript arrays and nested objects)
      Parameters:
        `object` -
      Returns:

    - #### hasAnalytics

          public static boolean hasAnalytics()

      Returns true is the optional Analytics module has been loaded.
      Returns:
        true if Analytics module is loaded

    - #### hasCharts

          public static boolean hasCharts()

      Returns true is the optional Charts module has been loaded.
      Returns:
        true if Charts module is loaded

    - #### hasDrawing

          public static boolean hasDrawing()

      Returns true is the optional Drawing module has been loaded.
      Returns:
        true if Drawing module is loaded

    - #### hasPluginBridges

          public static boolean hasPluginBridges()

      Returns true is the optional PluginBridges module has been loaded.
      Returns:
        true if PluginBridges module is loaded

    - #### hasRealtimeMessaging

          public static boolean hasRealtimeMessaging()

      Returns true is the optional RealtimeMessaging module has been loaded.
      Returns:
        true if RealtimeMessaging module is loaded

    - #### setScreenReaderMode

          public static void setScreenReaderMode(boolean newState)

      Enables full screen reader mode. Must be called before any components are created. See `Accessibility`.
      Parameters:
        `new` - state for screen reader mode (true for enabled, false for disabled)