|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.vaadin.client.ApplicationConnection
public class ApplicationConnection
This is the client side communication "engine", managing client-server
communication with its server side counterpart
com.vaadin.server.VaadinService.
Client-side connectors receive updates from the corresponding server-side
connector (typically component) as state updates or RPC calls. The connector
has the possibility to communicate back with its server side counter part
through RPC calls.
TODO document better
Entry point classes (widgetsets) define onModuleLoad().
| Nested Class Summary | |
|---|---|
static class |
ApplicationConnection.ApplicationConnectionEvent
|
static class |
ApplicationConnection.ApplicationState
|
static class |
ApplicationConnection.ApplicationStoppedEvent
Event triggered when a application is stopped by calling ApplicationConnection#setApplicationRunning(false). |
static interface |
ApplicationConnection.ApplicationStoppedHandler
A listener for listening to application stopped events. |
static interface |
ApplicationConnection.CommunicationErrorHandler
Allows custom handling of communication errors. |
static interface |
ApplicationConnection.CommunicationHandler
The communication handler methods are called at certain points during communication with the server. |
static class |
ApplicationConnection.MultiStepDuration
|
static class |
ApplicationConnection.RequestStartingEvent
|
static class |
ApplicationConnection.ResponseHandlingEndedEvent
|
static class |
ApplicationConnection.ResponseHandlingStartedEvent
|
| Field Summary | |
|---|---|
protected ConnectionStateHandler |
connectionStateHandler
|
protected boolean |
cssLoaded
|
static java.lang.String |
DISABLED_CLASSNAME
Deprecated. |
static java.lang.String |
ERROR_CLASSNAME_EXT
Deprecated. |
protected MessageHandler |
messageHandler
|
protected MessageSender |
messageSender
|
static java.lang.String |
MODIFIED_CLASSNAME
Deprecated. |
static java.lang.String |
REQUIRED_CLASSNAME
Deprecated. |
static java.lang.String |
REQUIRED_CLASSNAME_EXT
Deprecated. |
protected ServerRpcQueue |
serverRpcQueue
|
static java.lang.String |
UIDL_REFRESH_TOKEN
A string that, if found in a non-JSON response to a UIDL request, will cause the browser to refresh the page. |
| Constructor Summary | |
|---|---|
ApplicationConnection()
|
|
| Method Summary | ||
|---|---|---|
static java.lang.String |
addGetParameters(java.lang.String uri,
java.lang.String extraParams)
Deprecated. Use SharedUtil.addGetParameters(String,String)
instead |
|
|
addHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type,
H handler)
|
|
void |
analyzeLayouts()
Deprecated. as of 7.1. Replaced by UIConnector.analyzeLayouts() |
|
void |
captionSizeUpdated(Widget widget)
Deprecated. As of 7.0.2, has not had any effect for a long time |
|
void |
executeWhenCSSLoaded(Command c)
|
|
void |
fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
|
|
void |
flushActiveConnector()
Calls ComponentConnector.flush() on the active connector. |
|
void |
forceLayout()
This will cause re-layouting of all components. |
|
ApplicationConnection.ApplicationState |
getApplicationState()
Returns the state of this application. |
|
ApplicationConfiguration |
getConfiguration()
Gets the ApplicationConfiguration for the current application. |
|
ConnectionStateHandler |
getConnectionStateHandler()
Gets the communication error handler for this application |
|
ServerConnector |
getConnector(java.lang.String connectorId,
int connectorType)
Get either an existing ComponentConnector or create a new ComponentConnector with the given type and id. |
|
VContextMenu |
getContextMenu()
Singleton method to get instance of app's context menu. |
|
Heartbeat |
getHeartbeat()
Returns the hearbeat instance. |
|
Icon |
getIcon(java.lang.String uri)
Gets an Icon instance corresponding to a URI. |
|
int |
getLastSeenServerSyncId()
|
|
VLoadingIndicator |
getLoadingIndicator()
Returns the loading indicator used by this ApplicationConnection |
|
MessageHandler |
getMessageHandler()
Gets the (server to client) message handler for this application |
|
MessageSender |
getMessageSender()
Gets the (client to server) message sender for this application |
|
ComponentConnector |
getPaintable(UIDL uidl)
Deprecated. |
|
java.lang.String |
getResource(java.lang.String name)
Gets a resource that has been pre-loaded via UIDL, such as custom layouts. |
|
RpcManager |
getRpcManager()
Gets the server rpc manager for this application |
|
ServerRpcQueue |
getServerRpcQueue()
Gets the server RPC queue for this application |
|
java.lang.String |
getThemeUri()
Gets the URI for the current theme. |
|
UIConnector |
getUIConnector()
Gets the main view |
|
VTooltip |
getVTooltip()
Get VTooltip instance related to application connection |
|
WidgetSet |
getWidgetSet()
|
|
void |
handleCommunicationError(java.lang.String details,
int statusCode)
|
|
boolean |
handleComponentRelativeSize(Widget widget)
Deprecated. As of 7.0, serves no purpose |
|
boolean |
hasEventListeners(ComponentConnector connector,
java.lang.String eventIdentifier)
Deprecated. As of 7.0. Use AbstractConnector#hasEventListener(String) instead |
|
boolean |
hasEventListeners(Widget widget,
java.lang.String eventIdentifier)
Deprecated. As of 7.0. Use AbstractConnector.hasEventListener(String)
instead |
|
void |
init(WidgetSet widgetSet,
ApplicationConfiguration cnf)
|
|
boolean |
isApplicationRunning()
Checks if the application is in the ApplicationConnection.ApplicationState.RUNNING
state. |
|
protected boolean |
isCSSLoaded()
Checks whether or not the CSS is loaded. |
|
boolean |
isLoadingIndicatorVisible()
Deprecated. As of 7.1. Use getLoadingIndicator() and
VLoadingIndicator.isVisible().isVisible() instead. |
|
void |
loadScriptDependencies(JsArrayString dependencies)
|
|
void |
loadStyleDependencies(JsArrayString dependencies)
|
|
void |
runDescendentsLayout(HasWidgets container)
Deprecated. As of 7.0, serves no purpose |
|
protected void |
scheduleHeartbeat()
Deprecated. as of 7.2, use Heartbeat.schedule() instead |
|
protected void |
sendHeartbeat()
Deprecated. as of 7.2, use Heartbeat.send() instead |
|
void |
sendPendingVariableChanges()
Deprecated. as of 7.6, use ServerRpcQueue.flush() |
|
void |
setApplicationRunning(boolean applicationRunning)
|
|
void |
setCommunicationErrorDelegate(ApplicationConnection.CommunicationErrorHandler delegate)
Sets the delegate that is called whenever a communication error occurrs. |
|
void |
setResource(java.lang.String name,
java.lang.String resource)
Sets a resource that has been pre-loaded via UIDL, such as custom layouts. |
|
void |
showAuthenticationError(java.lang.String details)
Shows the authentication error notification. |
|
void |
showCommunicationError(java.lang.String details,
int statusCode)
Shows the communication error notification. |
|
protected void |
showError(java.lang.String details,
ApplicationConfiguration.ErrorMessage message)
Shows an error notification. |
|
void |
showSessionExpiredError(java.lang.String details)
Shows the session expiration notification. |
|
void |
start()
Starts this application. |
|
java.lang.String |
translateVaadinUri(java.lang.String uidlUri)
Translates custom protocols in UIDL URI's to be recognizable by browser. |
|
void |
unregisterPaintable(ServerConnector p)
Deprecated. As of 7.0. No longer serves any purpose. |
|
boolean |
updateComponent(Widget component,
UIDL uidl,
boolean manageCaption)
Deprecated. As of 7.0, no longer serves any purpose |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
boolean newValue,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
double newValue,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
float newValue,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
int newValue,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
long newValue,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
java.util.Map<java.lang.String,java.lang.Object> map,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
java.lang.Object[] values,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
ServerConnector newValue,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
java.lang.String[] values,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
void |
updateVariable(java.lang.String paintableId,
java.lang.String variableName,
java.lang.String newValue,
boolean immediate)
Sends a new value for the given paintables given variable to the server. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
@Deprecated public static final java.lang.String MODIFIED_CLASSNAME
@Deprecated public static final java.lang.String DISABLED_CLASSNAME
@Deprecated public static final java.lang.String REQUIRED_CLASSNAME
@Deprecated public static final java.lang.String REQUIRED_CLASSNAME_EXT
@Deprecated public static final java.lang.String ERROR_CLASSNAME_EXT
public static final java.lang.String UIDL_REFRESH_TOKEN
This allows, for instance, a servlet filter to redirect the application to a custom login page when the session expires. For example:
if (sessionExpired) {
response.setHeader("Content-Type", "text/html");
response.getWriter().write(
myLoginPageHtml + "<!-- Vaadin-Refresh: "
+ request.getContextPath() + " -->");
}
protected boolean cssLoaded
protected ServerRpcQueue serverRpcQueue
protected ConnectionStateHandler connectionStateHandler
protected MessageHandler messageHandler
protected MessageSender messageSender
| Constructor Detail |
|---|
public ApplicationConnection()
| Method Detail |
|---|
public void init(WidgetSet widgetSet,
ApplicationConfiguration cnf)
public void start()
ApplicationConfiguration#startNextApplication(), which should be
called once this application has started (first response received) or
failed to start. This ensures that the applications are started in order,
to avoid session-id problems.
@Deprecated public void analyzeLayouts()
UIConnector.analyzeLayouts()
public void executeWhenCSSLoaded(Command c)
protected boolean isCSSLoaded()
public void showCommunicationError(java.lang.String details,
int statusCode)
details - Optional details.statusCode - The status code returned for the requestpublic void showAuthenticationError(java.lang.String details)
details - Optional details.public void showSessionExpiredError(java.lang.String details)
details - Optional details.
protected void showError(java.lang.String details,
ApplicationConfiguration.ErrorMessage message)
details - Optional details.message - An ErrorMessage describing the error.public VLoadingIndicator getLoadingIndicator()
@Deprecated public boolean isLoadingIndicatorVisible()
getLoadingIndicator() and
VLoadingIndicator.isVisible().isVisible() instead.
public void loadStyleDependencies(JsArrayString dependencies)
public void loadScriptDependencies(JsArrayString dependencies)
@Deprecated public void sendPendingVariableChanges()
ServerRpcQueue.flush()
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
ServerConnector newValue,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablenewValue - the new value to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
java.lang.String newValue,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablenewValue - the new value to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
int newValue,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablenewValue - the new value to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
long newValue,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablenewValue - the new value to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
float newValue,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablenewValue - the new value to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
double newValue,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablenewValue - the new value to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
boolean newValue,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablenewValue - the new value to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
java.util.Map<java.lang.String,java.lang.Object> map,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablemap - the new values to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
java.lang.String[] values,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
A null array is sent as an empty array.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablevalues - the new value to be sentimmediate - true if the update is to be sent as soon as possible
public void updateVariable(java.lang.String paintableId,
java.lang.String variableName,
java.lang.Object[] values,
boolean immediate)
The update is actually queued to be sent at a suitable time. If immediate is true, the update is sent as soon as possible. If immediate is false, the update will be sent along with the next immediate update.
A null array is sent as an empty array.
paintableId - the id of the paintable that owns the variablevariableName - the name of the variablevalues - the new value to be sentimmediate - true if the update is to be sent as soon as possible@Deprecated public void runDescendentsLayout(HasWidgets container)
LayoutManager.
container - public void forceLayout()
@Deprecated public boolean handleComponentRelativeSize(Widget widget)
paintable -
@Deprecated public ComponentConnector getPaintable(UIDL uidl)
public ServerConnector getConnector(java.lang.String connectorId,
int connectorType)
connectorId - Id of the paintableconnectorType - Type of the connector, as passed from the server side
public java.lang.String getResource(java.lang.String name)
name - identifier of the resource to get
public void setResource(java.lang.String name,
java.lang.String resource)
name - identifier of the resource to Setresource - the resourcepublic VContextMenu getContextMenu()
public Icon getIcon(java.lang.String uri)
Icon instance corresponding to a URI.
uri -
public java.lang.String translateVaadinUri(java.lang.String uidlUri)
uidlUri - Vaadin URI from uidl
public java.lang.String getThemeUri()
@Deprecated public void captionSizeUpdated(Widget widget)
component - the Paintable whose caption has changedpublic UIConnector getUIConnector()
public ApplicationConfiguration getConfiguration()
ApplicationConfiguration for the current application.
ApplicationConfiguration
@Deprecated
public boolean hasEventListeners(ComponentConnector connector,
java.lang.String eventIdentifier)
AbstractConnector#hasEventListener(String) instead
connector - The connector to register event listeners foreventIdentifier - The identifier for the event
@Deprecated
public static java.lang.String addGetParameters(java.lang.String uri,
java.lang.String extraParams)
SharedUtil.addGetParameters(String,String)
instead
uri - The uri to which the parameters should be added.extraParams - One or more parameters in the format "a=b" or "c=d&e=f". An
empty string is allowed but will not modify the url.
@Deprecated public void unregisterPaintable(ServerConnector p)
public VTooltip getVTooltip()
@Deprecated
public boolean updateComponent(Widget component,
UIDL uidl,
boolean manageCaption)
component - uidl - manageCaption -
@Deprecated
public boolean hasEventListeners(Widget widget,
java.lang.String eventIdentifier)
AbstractConnector.hasEventListener(String)
instead
@Deprecated protected void scheduleHeartbeat()
Heartbeat.schedule() instead
@Deprecated protected void sendHeartbeat()
Heartbeat.send() instead
Heartbeat requests are used to inform the server that the client-side is still alive. If the client page is closed or the connection lost, the server will eventually close the inactive UI.
public void handleCommunicationError(java.lang.String details,
int statusCode)
public void setCommunicationErrorDelegate(ApplicationConnection.CommunicationErrorHandler delegate)
delegate - the delegate.public void setApplicationRunning(boolean applicationRunning)
public boolean isApplicationRunning()
ApplicationConnection.ApplicationState.RUNNING
state.
public <H extends com.google.gwt.event.shared.EventHandler> com.google.gwt.event.shared.HandlerRegistration addHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type,
H handler)
public void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
fireEvent in interface com.google.gwt.event.shared.HasHandlerspublic void flushActiveConnector()
ComponentConnector.flush() on the active connector. Does
nothing if there is no active (focused) connector.
public Heartbeat getHeartbeat()
public ApplicationConnection.ApplicationState getApplicationState()
public ServerRpcQueue getServerRpcQueue()
public ConnectionStateHandler getConnectionStateHandler()
public MessageHandler getMessageHandler()
public RpcManager getRpcManager()
public MessageSender getMessageSender()
public WidgetSet getWidgetSet()
public int getLastSeenServerSyncId()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||