com.google.gwt.dev.ui

Class DevModeUI

java.lang.Object

com.google.gwt.dev.ui.DevModeUI

Direct Known Subclasses:

HeadlessUI, RemoteUI, SwingUI

public abstract class DevModeUI
extends Object

Defines the interaction between DevelopmentMode and the UI, so that alternate UIs can be implemented.

Sequence of calls:

• #initialize(Type)
• getTopLogger()
• possibly getWebServerLogger(String, byte[])
• setStartupUrls(Map)
• moduleLoadComplete(boolean) or
• zero or more getModuleLogger(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, byte[], com.google.gwt.core.ext.TreeLogger.Type)

setCallback(com.google.gwt.dev.ui.UiEvent.Type, UiCallback) may be interspersed among these calls after #initialize(Type) is called.

Constructor Summary

Constructors

Constructor and Description
DevModeUI()

Method Summary

Methods

Modifier and Type	Method and Description
protected <C extends UiCallback> C	getCallback(UiEvent.Type<?> eventType) Call callback for a given event.
protected TreeLogger	getConsoleLogger()
protected TreeLogger.Type	getLogLevel()
abstract ModuleHandle	getModuleLogger(String userAgent, String remoteSocket, String url, String tabKey, String moduleName, String sessionKey, String agentTag, byte[] agentIcon, TreeLogger.Type logLevel) Show that a module is loaded in the UI.
TreeLogger	getTopLogger() Create a top-level logger for messages which are not associated with the web server or any module.
abstract TreeLogger	getWebServerLogger(String serverName, byte[] serverIcon) Create the web server portion of the UI if not already created, and return its TreeLogger instance.
protected boolean	hasCallback(UiEvent.Type<? extends UiCallback> eventType) Returns true if a callback has been registered for an event.
void	initialize(TreeLogger.Type logLevel) Initialize the UI - must be called exactly once and before any other method on this class.
void	moduleLoadComplete(boolean success) Indicates that all modules have been loaded (loading the XML, not completing onModuleLoad), and that URLs previously specified in setStartupUrls(Map) may be launched if successful.
<C extends UiCallback> void	setCallback(UiEvent.Type<C> type, C callback) Sets the callback for a given event type..
void	setStartupUrls(Map<String,URL> urls) Set the URLs that should be available to start.
void	setWebServerSecure(TreeLogger serverLogger) Show in the UI that the web server, identified by the logger returned from getWebServerLogger(String, byte[]), is operating in a secure fashion.

Methods inherited from class java.lang.Object

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

Constructor Detail

DevModeUI

public DevModeUI()

Method Detail

getModuleLogger

public abstract ModuleHandle getModuleLogger(String userAgent,
                           String remoteSocket,
                           String url,
                           String tabKey,
                           String moduleName,
                           String sessionKey,
                           String agentTag,
                           byte[] agentIcon,
                           TreeLogger.Type logLevel)

Show that a module is loaded in the UI.

Note that the CloseModuleEvent should already have a callback registered when this is called if needed -- the UI is not required to change the UI if it is registered later.

Parameters:

userAgent - full user agent name

remoteSocket - name of remote socket endpoint in host:port format

url - URL of top-level window

tabKey - stable browser tab identifier, or the empty string if no such identifier is available

moduleName - the name of the module loaded

sessionKey - a unique session key

agentTag - short-form user agent identifier, suitable for use in a label for this connection

agentIcon - icon to use for the user agent (fits inside 24x24) or null if unavailable

logLevel - logging detail requested

Returns:

a handle to the module

getTopLogger

public TreeLogger getTopLogger()

Create a top-level logger for messages which are not associated with the web server or any module. Defaults to logging to stdout.

Returns:

TreeLogger instance to use

getWebServerLogger

public abstract TreeLogger getWebServerLogger(String serverName,
                            byte[] serverIcon)

Create the web server portion of the UI if not already created, and return its TreeLogger instance.

Note that the RestartServerEvent should already have a callback registered when this is called -- the UI is not required to change the UI if it is registered later.

Parameters:

serverName - short name of the web server or null if only the icon should be used

serverIcon - byte array containing an icon (fitting into 24x24) to use for the server, or null if only the name should be used

Returns:

TreeLogger instance

initialize

public void initialize(TreeLogger.Type logLevel)

Initialize the UI - must be called exactly once and before any other method on this class.

Subclasses should call super.initialize(logLevel).

Parameters:

logLevel - log level for all logging

moduleLoadComplete

public void moduleLoadComplete(boolean success)

Indicates that all modules have been loaded (loading the XML, not completing onModuleLoad), and that URLs previously specified in setStartupUrls(Map) may be launched if successful.

Parameters:

success - true if all modules were successfully loaded

setCallback

public final <C extends UiCallback> void setCallback(UiEvent.Type<C> type,
                                      C callback)

Sets the callback for a given event type..

Type Parameters:

C - callback type

Parameters:

type - UI event type token

callback - event callback, or null to clear the callback

setStartupUrls

public void setStartupUrls(Map<String,URL> urls)

Set the URLs that should be available to start.

Parameters:

urls - map of URLs -- the key is the name supplied with -startupUrls, and the value is the mapped URL with all parameters included

setWebServerSecure

public void setWebServerSecure(TreeLogger serverLogger)

Show in the UI that the web server, identified by the logger returned from getWebServerLogger(String, byte[]), is operating in a secure fashion.

Parameters:

serverLogger -

getCallback

protected final <C extends UiCallback> C getCallback(UiEvent.Type<?> eventType)

Call callback for a given event.

Parameters:

eventType - type of event

Returns:

the UiCallback for this event or null if none

getConsoleLogger

protected final TreeLogger getConsoleLogger()

Returns:

a console-based logger.

getLogLevel

protected final TreeLogger.Type getLogLevel()

Returns:

the log level for all logging.

hasCallback

protected final boolean hasCallback(UiEvent.Type<? extends UiCallback> eventType)

Returns true if a callback has been registered for an event.

Parameters:

eventType - type of event

Returns:

true if a callback has been registered for event