From: Marc Englund <marc@vaadin.com>
Date: Thu, 22 Dec 2011 14:48:01 +0000 (+0200)
Subject: Javadocced the fact that root preserving should not be toggled on-the-fly when the... 
X-Git-Tag: 7.0.0.alpha1~5
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=fd2f595812fc328624be7f1c70c5951d0328fcfc;p=vaadin-framework.git

Javadocced the fact that root preserving should not be toggled on-the-fly when the UI is showing.
---

diff --git a/src/com/vaadin/Application.java b/src/com/vaadin/Application.java
index 83084f4213..8e88a677f6 100644
--- a/src/com/vaadin/Application.java
+++ b/src/com/vaadin/Application.java
@@ -2319,6 +2319,10 @@ public class Application implements Terminal.ErrorListener, Serializable {
      * detect that the application is opened in a browser window where it has
      * previously been open. The framework attempts to discover this by checking
      * the value of window.name in the browser.
+     * <p>
+     * NOTE that you should avoid turning this feature on/off on-the-fly when
+     * the UI is already shown, as it might not be retained as intended.
+     * </p>
      * 
      * @param rootPreserved
      *            <code>true</code>if the same Root instance should be reused