|
|
@@ -110,14 +110,14 @@ import com.vaadin.shared.ui.ui.UIState.PushConfigurationState; |
|
|
|
* 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 <code>onModuleLoad()</code>. |
|
|
|
*/ |
|
|
|
public class ApplicationConnection implements HasHandlers { |
|
|
@@ -156,12 +156,12 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* A string that, if found in a non-JSON response to a UIDL request, will |
|
|
|
* cause the browser to refresh the page. If followed by a colon, optional |
|
|
|
* whitespace, and a URI, causes the browser to synchronously load the URI. |
|
|
|
* |
|
|
|
* |
|
|
|
* <p> |
|
|
|
* This allows, for instance, a servlet filter to redirect the application |
|
|
|
* to a custom login page when the session expires. For example: |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* <pre> |
|
|
|
* if (sessionExpired) { |
|
|
|
* response.setHeader("Content-Type", "text/html"); |
|
|
@@ -344,7 +344,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Event triggered when a XHR request has finished with the status code of |
|
|
|
* the response. |
|
|
|
* |
|
|
|
* |
|
|
|
* Useful for handlers observing network failures like online/off-line |
|
|
|
* monitors. |
|
|
|
*/ |
|
|
@@ -400,12 +400,12 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Event triggered when a application is stopped by calling |
|
|
|
* {@link ApplicationConnection#setApplicationRunning(false)}. |
|
|
|
* |
|
|
|
* |
|
|
|
* To listen for the event add a {@link ApplicationStoppedHandler} by |
|
|
|
* invoking |
|
|
|
* {@link ApplicationConnection#addHandler(ApplicationConnection.ApplicationStoppedEvent.Type, ApplicationStoppedHandler)} |
|
|
|
* to the {@link ApplicationConnection} |
|
|
|
* |
|
|
|
* |
|
|
|
* @since 7.1.8 |
|
|
|
* @author Vaadin Ltd |
|
|
|
*/ |
|
|
@@ -432,7 +432,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Called when a communication error has occurred. Returning |
|
|
|
* <code>true</code> from this method suppresses error handling. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param details |
|
|
|
* A string describing the error. |
|
|
|
* @param statusCode |
|
|
@@ -447,7 +447,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* A listener for listening to application stopped events. The listener can |
|
|
|
* be added to a {@link ApplicationConnection} by invoking |
|
|
|
* {@link ApplicationConnection#addHandler(ApplicationStoppedEvent.Type, ApplicationStoppedHandler)} |
|
|
|
* |
|
|
|
* |
|
|
|
* @since 7.1.8 |
|
|
|
* @author Vaadin Ltd |
|
|
|
*/ |
|
|
@@ -457,7 +457,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* Triggered when the {@link ApplicationConnection} marks a previously |
|
|
|
* running application as stopped by invoking |
|
|
|
* {@link ApplicationConnection#setApplicationRunning(false)} |
|
|
|
* |
|
|
|
* |
|
|
|
* @param event |
|
|
|
* the event triggered by the {@link ApplicationConnection} |
|
|
|
*/ |
|
|
@@ -560,7 +560,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
public void start() { |
|
|
|
String jsonText = configuration.getUIDL(); |
|
|
@@ -637,7 +637,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
return componentLocator.@com.vaadin.client.componentlocator.ComponentLocator::getElementsByPathStartingAt(Ljava/lang/String;Lcom/google/gwt/dom/client/Element;)(id, element); |
|
|
|
}); |
|
|
|
client.getPathForElement = $entry(function(element) { |
|
|
|
return componentLocator.@com.vaadin.client.componentlocator.ComponentLocator::getLegacyPathForElement(Lcom/google/gwt/dom/client/Element;)(element); |
|
|
|
return componentLocator.@com.vaadin.client.componentlocator.ComponentLocator::getPathForElement(Lcom/google/gwt/dom/client/Element;)(element); |
|
|
|
}); |
|
|
|
client.initializing = false; |
|
|
|
|
|
|
@@ -670,7 +670,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* <li><code>vaadin.postRequestHooks</code> is a map of functions which gets |
|
|
|
* called after each XHR made by vaadin application. Note, that it is |
|
|
|
* attaching js functions responsibility to create the variable like this: |
|
|
|
* |
|
|
|
* |
|
|
|
* <code><pre> |
|
|
|
* if(!vaadin.postRequestHooks) {vaadin.postRequestHooks = new Object();} |
|
|
|
* postRequestHooks.myHook = function(appId) { |
|
|
@@ -681,7 +681,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* </pre></code> First parameter passed to these functions is the identifier |
|
|
|
* of Vaadin application that made the request. |
|
|
|
* </ul> |
|
|
|
* |
|
|
|
* |
|
|
|
* TODO make this multi-app aware |
|
|
|
*/ |
|
|
|
private native void initializeClientHooks() |
|
|
@@ -712,7 +712,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Runs possibly registered client side post request hooks. This is expected |
|
|
|
* to be run after each uidl request made by Vaadin application. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param appId |
|
|
|
*/ |
|
|
|
private static native void runPostRequestHooks(String appId) |
|
|
@@ -732,7 +732,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* If on Liferay and logged in, ask the client side session management |
|
|
|
* JavaScript to extend the session duration. |
|
|
|
* |
|
|
|
* |
|
|
|
* Otherwise, Liferay client side JavaScript will explicitly expire the |
|
|
|
* session even though the server side considers the session to be active. |
|
|
|
* See ticket #8305 for more information. |
|
|
@@ -751,7 +751,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Indicates whether or not there are currently active UIDL requests. Used |
|
|
|
* internally to sequence requests properly, seldom needed in Widgets. |
|
|
|
* |
|
|
|
* |
|
|
|
* @return true if there are active requests |
|
|
|
*/ |
|
|
|
public boolean hasActiveRequest() { |
|
|
@@ -771,7 +771,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Requests an analyze of layouts, to find inconsistencies. Exclusively used |
|
|
|
* for debugging during development. |
|
|
|
* |
|
|
|
* |
|
|
|
* @deprecated as of 7.1. Replaced by {@link UIConnector#analyzeLayouts()} |
|
|
|
*/ |
|
|
|
@Deprecated |
|
|
@@ -783,7 +783,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* Sends a request to the server to print details to console that will help |
|
|
|
* the developer to locate the corresponding server-side connector in the |
|
|
|
* source code. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param serverConnector |
|
|
|
* @deprecated as of 7.1. Replaced by |
|
|
|
* {@link UIConnector#showServerDebugInfo(ServerConnector)} |
|
|
@@ -795,7 +795,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Makes an UIDL request to the server. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param reqInvocations |
|
|
|
* Data containing RPC invocations and all related information. |
|
|
|
* @param extraParams |
|
|
@@ -835,7 +835,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Sends an asynchronous or synchronous UIDL request to the server using the |
|
|
|
* given URI. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param uri |
|
|
|
* The URI to use for the request. May includes GET parameters |
|
|
|
* @param payload |
|
|
@@ -1004,7 +1004,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Handles received UIDL JSON text, parsing it, and passing it on to the |
|
|
|
* appropriate handlers, while logging timing information. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param jsonText |
|
|
|
* @param statusCode |
|
|
|
*/ |
|
|
@@ -1032,7 +1032,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Sends an asynchronous UIDL request to the server using the given URI. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param uri |
|
|
|
* The URI to use for the request. May includes GET parameters |
|
|
|
* @param payload |
|
|
@@ -1167,7 +1167,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Checks whether or not the CSS is loaded. By default checks the size of |
|
|
|
* the loading indicator element. |
|
|
|
* |
|
|
|
* |
|
|
|
* @return |
|
|
|
*/ |
|
|
|
protected boolean isCSSLoaded() { |
|
|
@@ -1177,12 +1177,12 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Shows the communication error notification. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param details |
|
|
|
* Optional details for debugging. |
|
|
|
* @param statusCode |
|
|
|
* The status code returned for the request |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
protected void showCommunicationError(String details, int statusCode) { |
|
|
|
VConsole.error("Communication error: " + details); |
|
|
@@ -1191,7 +1191,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Shows the authentication error notification. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param details |
|
|
|
* Optional details for debugging. |
|
|
|
*/ |
|
|
@@ -1202,7 +1202,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Shows the session expiration notification. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param details |
|
|
|
* Optional details for debugging. |
|
|
|
*/ |
|
|
@@ -1213,7 +1213,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Shows an error notification. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param details |
|
|
|
* Optional details for debugging. |
|
|
|
* @param message |
|
|
@@ -1226,7 +1226,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Shows the error notification. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param details |
|
|
|
* Optional details for debugging. |
|
|
|
*/ |
|
|
@@ -1313,7 +1313,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* This method is called after applying uidl change set to application. |
|
|
|
* |
|
|
|
* |
|
|
|
* It will clean current and queued variable change sets. And send next |
|
|
|
* change set if it exists. |
|
|
|
*/ |
|
|
@@ -1332,7 +1332,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Cleans given queue of variable changes of such changes that came from |
|
|
|
* components that do not exist anymore. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param variableBurst |
|
|
|
*/ |
|
|
|
private void cleanVariableBurst( |
|
|
@@ -1381,7 +1381,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* <p> |
|
|
|
* Used by the native "client.isActive" function. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @return true if deferred commands are (potentially) being executed, false |
|
|
|
* otherwise |
|
|
|
*/ |
|
|
@@ -1396,7 +1396,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Returns the loading indicator used by this ApplicationConnection |
|
|
|
* |
|
|
|
* |
|
|
|
* @return The loading indicator for this ApplicationConnection |
|
|
|
*/ |
|
|
|
public VLoadingIndicator getLoadingIndicator() { |
|
|
@@ -1405,7 +1405,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Determines whether or not the loading indicator is showing. |
|
|
|
* |
|
|
|
* |
|
|
|
* @return true if the loading indicator is visible |
|
|
|
* @deprecated As of 7.1. Use {@link #getLoadingIndicator()} and |
|
|
|
* {@link VLoadingIndicator#isVisible()}.isVisible() instead. |
|
|
@@ -1439,7 +1439,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* server is received. |
|
|
|
* <p> |
|
|
|
* The initial id when no request has yet been processed is -1. |
|
|
|
* |
|
|
|
* |
|
|
|
* @return and id identifying the response |
|
|
|
*/ |
|
|
|
public int getLastResponseId() { |
|
|
@@ -1868,13 +1868,13 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Sends the state change events created while updating the state |
|
|
|
* information. |
|
|
|
* |
|
|
|
* |
|
|
|
* This must be called after hierarchy change listeners have been |
|
|
|
* called. At least caption updates for the parent are strange if |
|
|
|
* fired from state change listeners and thus calls the parent |
|
|
|
* BEFORE the parent is aware of the child (through a |
|
|
|
* ConnectorHierarchyChangedEvent) |
|
|
|
* |
|
|
|
* |
|
|
|
* @param pendingStateChangeEvents |
|
|
|
* The events to send |
|
|
|
*/ |
|
|
@@ -2205,7 +2205,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* Updates the connector hierarchy and returns a list of events that |
|
|
|
* should be fired after update of the hierarchy and the state is |
|
|
|
* done. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param json |
|
|
|
* The JSON containing the hierarchy information |
|
|
|
* @return A collection of events that should be fired when update |
|
|
@@ -2605,9 +2605,9 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Adds an explicit RPC method invocation to the send queue. |
|
|
|
* |
|
|
|
* |
|
|
|
* @since 7.0 |
|
|
|
* |
|
|
|
* |
|
|
|
* @param invocation |
|
|
|
* RPC method invocation |
|
|
|
* @param delayed |
|
|
@@ -2647,7 +2647,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Removes any pending invocation of the given method from the queue |
|
|
|
* |
|
|
|
* |
|
|
|
* @param invocation |
|
|
|
* The invocation to remove |
|
|
|
*/ |
|
|
@@ -2665,12 +2665,12 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* This method sends currently queued variable changes to server. It is |
|
|
|
* called when immediate variable update must happen. |
|
|
|
* |
|
|
|
* |
|
|
|
* To ensure correct order for variable changes (due servers multithreading |
|
|
|
* or network), we always wait for active request to be handler before |
|
|
|
* sending a new one. If there is an active request, we will put varible |
|
|
|
* "burst" to queue that will be purged after current request is handled. |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
public void sendPendingVariableChanges() { |
|
|
|
if (!deferedSendPending) { |
|
|
@@ -2711,11 +2711,11 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Build the variable burst and send it to server. |
|
|
|
* |
|
|
|
* |
|
|
|
* When sync is forced, we also force sending of all pending variable-bursts |
|
|
|
* at the same time. This is ok as we can assume that DOM will never be |
|
|
|
* updated after this. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param pendingInvocations |
|
|
|
* List of RPC method invocations to send |
|
|
|
*/ |
|
|
@@ -2802,7 +2802,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -2824,7 +2824,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -2847,7 +2847,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -2870,7 +2870,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -2893,7 +2893,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -2916,7 +2916,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -2939,7 +2939,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -2962,7 +2962,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -2979,13 +2979,13 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Sends a new value for the given paintables given variable to the server. |
|
|
|
* |
|
|
|
* |
|
|
|
* 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. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -3002,14 +3002,14 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Sends a new value for the given paintables given variable to the server. |
|
|
|
* |
|
|
|
* |
|
|
|
* 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. </p> |
|
|
|
* |
|
|
|
* |
|
|
|
* A null array is sent as an empty array. |
|
|
|
* |
|
|
|
* |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintableId |
|
|
|
* the id of the paintable that owns the variable |
|
|
|
* @param variableName |
|
|
@@ -3026,7 +3026,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Does absolutely nothing. Replaced by {@link LayoutManager}. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param container |
|
|
|
* @deprecated As of 7.0, serves no purpose |
|
|
|
*/ |
|
|
@@ -3048,7 +3048,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Returns false |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintable |
|
|
|
* @return false, always |
|
|
|
* @deprecated As of 7.0, serves no purpose |
|
|
@@ -3060,7 +3060,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Returns false |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintable |
|
|
|
* @return false, always |
|
|
|
* @deprecated As of 7.0, serves no purpose |
|
|
@@ -3081,16 +3081,16 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Get either an existing ComponentConnector or create a new |
|
|
|
* ComponentConnector with the given type and id. |
|
|
|
* |
|
|
|
* |
|
|
|
* If a ComponentConnector with the given id already exists, returns it. |
|
|
|
* Otherwise creates and registers a new ComponentConnector of the given |
|
|
|
* type. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param connectorId |
|
|
|
* Id of the paintable |
|
|
|
* @param connectorType |
|
|
|
* Type of the connector, as passed from the server side |
|
|
|
* |
|
|
|
* |
|
|
|
* @return Either an existing ComponentConnector or a new ComponentConnector |
|
|
|
* of the given type |
|
|
|
*/ |
|
|
@@ -3103,15 +3103,15 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Creates a new ServerConnector with the given type and id. |
|
|
|
* |
|
|
|
* |
|
|
|
* Creates and registers a new ServerConnector of the given type. Should |
|
|
|
* never be called with the connector id of an existing connector. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param connectorId |
|
|
|
* Id of the new connector |
|
|
|
* @param connectorType |
|
|
|
* Type of the connector, as passed from the server side |
|
|
|
* |
|
|
|
* |
|
|
|
* @return A new ServerConnector of the given type |
|
|
|
*/ |
|
|
|
private ServerConnector createAndRegisterConnector(String connectorId, |
|
|
@@ -3131,7 +3131,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Gets a recource that has been pre-loaded via UIDL, such as custom |
|
|
|
* layouts. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param name |
|
|
|
* identifier of the resource to get |
|
|
|
* @return the resource |
|
|
@@ -3142,7 +3142,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Singleton method to get instance of app's context menu. |
|
|
|
* |
|
|
|
* |
|
|
|
* @return VContextMenu object |
|
|
|
*/ |
|
|
|
public VContextMenu getContextMenu() { |
|
|
@@ -3157,7 +3157,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Gets an {@link Icon} instance corresponding to a URI. |
|
|
|
* |
|
|
|
* |
|
|
|
* @since 7.2 |
|
|
|
* @param uri |
|
|
|
* @return Icon object |
|
|
@@ -3179,7 +3179,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* Translates custom protocols in UIDL URI's to be recognizable by browser. |
|
|
|
* All uri's from UIDL should be routed via this method before giving them |
|
|
|
* to browser due URI's in UIDL may contain custom protocols like theme://. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param uidlUri |
|
|
|
* Vaadin URI from uidl |
|
|
|
* @return translated URI ready for browser |
|
|
@@ -3251,7 +3251,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Gets the URI for the current theme. Can be used to reference theme |
|
|
|
* resources. |
|
|
|
* |
|
|
|
* |
|
|
|
* @return URI to the current theme |
|
|
|
*/ |
|
|
|
public String getThemeUri() { |
|
|
@@ -3262,7 +3262,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Listens for Notification hide event, and redirects. Used for system |
|
|
|
* messages, such as session expired. |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
private class NotificationRedirect implements VNotification.EventListener { |
|
|
|
String url; |
|
|
@@ -3291,7 +3291,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Gets the token (aka double submit cookie) that the server uses to protect |
|
|
|
* against Cross Site Request Forgery attacks. |
|
|
|
* |
|
|
|
* |
|
|
|
* @return the CSRF token string |
|
|
|
*/ |
|
|
|
public String getCsrfToken() { |
|
|
@@ -3301,7 +3301,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Use to notify that the given component's caption has changed; layouts may |
|
|
|
* have to be recalculated. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param component |
|
|
|
* the Paintable whose caption has changed |
|
|
|
* @deprecated As of 7.0.2, has not had any effect for a long time |
|
|
@@ -3313,7 +3313,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Gets the main view |
|
|
|
* |
|
|
|
* |
|
|
|
* @return the main view |
|
|
|
*/ |
|
|
|
public UIConnector getUIConnector() { |
|
|
@@ -3322,7 +3322,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Gets the {@link ApplicationConfiguration} for the current application. |
|
|
|
* |
|
|
|
* |
|
|
|
* @see ApplicationConfiguration |
|
|
|
* @return the configuration for this application |
|
|
|
*/ |
|
|
@@ -3335,7 +3335,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* list of events which has server side listeners is updated automatically |
|
|
|
* before the component is updated so the value is correct if called from |
|
|
|
* updatedFromUIDL. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param paintable |
|
|
|
* The connector to register event listeners for |
|
|
|
* @param eventIdentifier |
|
|
@@ -3355,7 +3355,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Adds the get parameters to the uri and returns the new uri that contains |
|
|
|
* the parameters. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param uri |
|
|
|
* The uri to which the parameters should be added. |
|
|
|
* @param extraParams |
|
|
@@ -3408,7 +3408,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Get VTooltip instance related to application connection |
|
|
|
* |
|
|
|
* |
|
|
|
* @return VTooltip instance |
|
|
|
*/ |
|
|
|
public VTooltip getVTooltip() { |
|
|
@@ -3420,7 +3420,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* this method is now handled by the state change event handler in |
|
|
|
* AbstractComponentConnector. The only function this method has is to |
|
|
|
* return true if the UIDL is a "cached" update. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param component |
|
|
|
* @param uidl |
|
|
|
* @param manageCaption |
|
|
@@ -3471,7 +3471,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* Schedules a heartbeat request to occur after the configured heartbeat |
|
|
|
* interval elapses if the interval is a positive number. Otherwise, does |
|
|
|
* nothing. |
|
|
|
* |
|
|
|
* |
|
|
|
* @deprecated as of 7.2, use {@link Heartbeat#schedule()} instead |
|
|
|
*/ |
|
|
|
@Deprecated |
|
|
@@ -3485,7 +3485,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
* 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. |
|
|
|
* |
|
|
|
* |
|
|
|
* @deprecated as of 7.2, use {@link Heartbeat#send()} instead |
|
|
|
*/ |
|
|
|
@Deprecated |
|
|
@@ -3509,7 +3509,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* This method can be used to postpone rendering of a response for a short |
|
|
|
* period of time (e.g. to avoid the rendering process during animation). |
|
|
|
* |
|
|
|
* |
|
|
|
* @param lock |
|
|
|
*/ |
|
|
|
public void suspendReponseHandling(Object lock) { |
|
|
@@ -3518,7 +3518,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Resumes the rendering process once all locks have been removed. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param lock |
|
|
|
*/ |
|
|
|
public void resumeResponseHandling(Object lock) { |
|
|
@@ -3563,7 +3563,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Sets the delegate that is called whenever a communication error occurrs. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param delegate |
|
|
|
* the delegate. |
|
|
|
*/ |
|
|
@@ -3606,7 +3606,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Gets the active connector for focused element in browser. |
|
|
|
* |
|
|
|
* |
|
|
|
* @return Connector for focused element or null. |
|
|
|
*/ |
|
|
|
private ComponentConnector getActiveConnector() { |
|
|
@@ -3620,7 +3620,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
|
|
|
|
/** |
|
|
|
* Sets the status for the push connection. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param enabled |
|
|
|
* <code>true</code> to enable the push connection; |
|
|
|
* <code>false</code> to disable the push connection. |
|
|
@@ -3670,7 +3670,7 @@ public class ApplicationConnection implements HasHandlers { |
|
|
|
/** |
|
|
|
* Returns a human readable string representation of the method used to |
|
|
|
* communicate with the server. |
|
|
|
* |
|
|
|
* |
|
|
|
* @since 7.1 |
|
|
|
* @return A string representation of the current transport type |
|
|
|
*/ |