com.vaadin.terminal.gwt.client
Class ApplicationConfiguration

java.lang.Object
  com.vaadin.terminal.gwt.client.ApplicationConfiguration

All Implemented Interfaces:

com.google.gwt.core.client.EntryPoint

public class ApplicationConfiguration
extends Object
implements com.google.gwt.core.client.EntryPoint

Field Summary

static String

VERSION Builds number.

Constructor Summary

ApplicationConfiguration()

Method Summary

void	addComponentMappings(ValueMap valueMap, WidgetSet widgetSet)
String	getApplicationUri() Gets the application base URI.
String	getApplicationVersion()
String	getAuthorizationErrorCaption()
String	getAuthorizationErrorMessage()
String	getAuthorizationErrorUrl()
String	getCommunicationErrorCaption()
String	getCommunicationErrorMessage()
String	getCommunicationErrorUrl()
static ApplicationConfiguration	getConfigFromDOM(String appId)
String	getInitialWindowName()
String	getPortletUidlURLBase()
String	getRequiredWidgetset()
String	getRootPanelId()
static List<ApplicationConnection>	getRunningApplications()
String	getServletVersion()
String	getThemeUri()
com.google.gwt.core.client.JavaScriptObject	getVersionInfoJSObject()
Class<? extends Paintable>	getWidgetClassByEncodedTag(String tag)
static void	initConfigurations() Inits the ApplicationConfiguration by reading the DOM and instantiating ApplicationConnections accordingly.
static boolean	isDebugMode() Checks if client side is in debug mode.
static boolean	isQuietDebugMode() Checks whether debug logging should be quiet
boolean	isStandalone()
void	onModuleLoad()
void	setAppId(String appId)
void	setInitialWindowName(String name)
static boolean	startNextApplication() Starts the next unstarted application.
boolean	useDebugIdInDOM()
boolean	usePortletURLs()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

Builds number. For example 0-custom_tag in 5.0.0-custom_tag.

Constructor Detail

ApplicationConfiguration

public ApplicationConfiguration()

Method Detail

usePortletURLs

public boolean usePortletURLs()

getPortletUidlURLBase

public String getPortletUidlURLBase()

getRootPanelId

public String getRootPanelId()

getApplicationUri

public String getApplicationUri()

Gets the application base URI. Using this other than as the download action URI can cause problems in Portlet 2.0 deployments.

Returns:

application base URI

getThemeUri

public String getThemeUri()

setAppId

public void setAppId(String appId)

isStandalone

public boolean isStandalone()

Returns:

true if the application is served by std. Vaadin servlet and is considered to be the only or main content of the host page.

setInitialWindowName

public void setInitialWindowName(String name)

getInitialWindowName

public String getInitialWindowName()

getVersionInfoJSObject

public com.google.gwt.core.client.JavaScriptObject getVersionInfoJSObject()

getCommunicationErrorCaption

public String getCommunicationErrorCaption()

getCommunicationErrorMessage

public String getCommunicationErrorMessage()

getCommunicationErrorUrl

public String getCommunicationErrorUrl()

getAuthorizationErrorCaption

public String getAuthorizationErrorCaption()

getAuthorizationErrorMessage

public String getAuthorizationErrorMessage()

getAuthorizationErrorUrl

public String getAuthorizationErrorUrl()

getRequiredWidgetset

public String getRequiredWidgetset()

initConfigurations

public static void initConfigurations()

Inits the ApplicationConfiguration by reading the DOM and instantiating ApplicationConnections accordingly. Call startNextApplication() to actually start the applications.

Parameters:

widgetset - the widgetset that is running the apps

startNextApplication

public static boolean startNextApplication()

Starts the next unstarted application. The WidgetSet should call this once to start the first application; after that, each application should call this once it has started. This ensures that the applications are started synchronously, which is neccessary to avoid session-id problems.

Returns:

true if an unstarted application was found

getRunningApplications

public static List<ApplicationConnection> getRunningApplications()

getConfigFromDOM

public static ApplicationConfiguration getConfigFromDOM(String appId)

getServletVersion

public String getServletVersion()

getApplicationVersion

public String getApplicationVersion()

useDebugIdInDOM

public boolean useDebugIdInDOM()

getWidgetClassByEncodedTag

public Class<? extends Paintable> getWidgetClassByEncodedTag(String tag)

addComponentMappings

public void addComponentMappings(ValueMap valueMap,
                                 WidgetSet widgetSet)

onModuleLoad

public void onModuleLoad()

Specified by:

onModuleLoad in interface com.google.gwt.core.client.EntryPoint

isDebugMode

public static boolean isDebugMode()

Checks if client side is in debug mode. Practically this is invoked by adding ?debug parameter to URI.

Returns:

true if client side is currently been debugged

isQuietDebugMode

public static boolean isQuietDebugMode()

Checks whether debug logging should be quiet

Returns:

true if debug logging should be quiet