Merged VView changes to 6.8 (#8799).

svn changeset:23820/svn branch:6.8

1 files changed, 99 insertions, 22 deletions

diff --git a/src/com/vaadin/terminal/gwt/client/ui/VView.java b/src/com/vaadin/terminal/gwt/client/ui/VView.java
index e544a56190..350c4b206b 100644
--- a/src/com/vaadin/terminal/gwt/client/ui/VView.java
+++ b/src/com/vaadin/terminal/gwt/client/ui/VView.java
@@ -55,6 +55,8 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
 
     public static final String NOTIFICATION_HTML_CONTENT_NOT_ALLOWED = "useplain";
 
+    private static int MONITOR_PARENT_TIMER_INTERVAL = 1000;
+
     private String theme;
 
     private Paintable layout;
@@ -67,8 +69,8 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
 
     /*
      * Last known window size used to detect whether VView should be layouted
-     * again. Detection must be based on window size, because the VView size
-     * might be fixed and thus not automatically adapt to changed window sizes.
+     * again. Detection must check window size, because the VView size might be
+     * fixed and thus not automatically adapt to changed window sizes.
      */
     private int windowWidth;
     private int windowHeight;
@@ -76,13 +78,19 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
     private ApplicationConnection connection;
 
     /**
-     * We are postponing resize process with IE. IE bugs with scrollbars in some
-     * situations, that causes false onWindowResized calls. With Timer we will
-     * give IE some time to decide if it really wants to keep current size
-     * (scrollbars).
+     * Keep track of possible parent size changes when an embedded application.
+     * 
+     * Uses {@link #parentWidth} and {@link #parentHeight} as an optimization to
+     * keep track of when there is a real change.
      */
     private Timer resizeTimer;
 
+    /** stored width of parent for embedded application auto-resize */
+    private int parentWidth;
+
+    /** stored height of parent for embedded application auto-resize */
+    private int parentHeight;
+
     private int scrollTop;
 
     private int scrollLeft;
@@ -115,8 +123,7 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
     private VLazyExecutor delayedResizeExecutor = new VLazyExecutor(200,
             new ScheduledCommand() {
                 public void execute() {
-                    windowSizeMaybeChanged(Window.getClientWidth(),
-                            Window.getClientHeight());
+                    performSizeCheck();
                 }
 
             });
@@ -129,28 +136,75 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
         // should not be in the document focus flow
         getElement().setTabIndex(-1);
         TouchScrollDelegate.enableTouchScrolling(this, getElement());
+
+        if (isMonitoringParentSize()) {
+            resizeTimer = new Timer() {
+                @Override
+                public void run() {
+                    // trigger check to see if parent size has changed,
+                    // recalculate layouts
+                    performSizeCheck();
+                    resizeTimer.schedule(MONITOR_PARENT_TIMER_INTERVAL);
+                }
+            };
+            resizeTimer.schedule(MONITOR_PARENT_TIMER_INTERVAL);
+        }
     }
 
     /**
-     * Called when the window might have been resized.
+     * Called when the window or parent div might have been resized.
      * 
-     * @param newWidth
+     * This immediately checks the sizes of the window and the parent div (if
+     * monitoring it) and triggers layout recalculation if they have changed.
+     */
+    protected void performSizeCheck() {
+        windowSizeMaybeChanged(Window.getClientWidth(),
+                Window.getClientHeight());
+    }
+
+    /**
+     * Called when the window or parent div might have been resized.
+     * 
+     * This immediately checks the sizes of the window and the parent div (if
+     * monitoring it) and triggers layout recalculation if they have changed.
+     * 
+     * @param newWindowWidth
      *            The new width of the window
-     * @param newHeight
+     * @param newWindowHeight
      *            The new height of the window
+     * 
+     * @deprecated use {@link #performSizeCheck()}
      */
-    protected void windowSizeMaybeChanged(int newWidth, int newHeight) {
+    @Deprecated
+    protected void windowSizeMaybeChanged(int newWindowWidth,
+            int newWindowHeight) {
         boolean changed = false;
-        if (windowWidth != newWidth) {
-            windowWidth = newWidth;
+        if (windowWidth != newWindowWidth) {
+            windowWidth = newWindowWidth;
             changed = true;
             VConsole.log("New window width: " + windowWidth);
         }
-        if (windowHeight != newHeight) {
-            windowHeight = newHeight;
+        if (windowHeight != newWindowHeight) {
+            windowHeight = newWindowHeight;
             changed = true;
             VConsole.log("New window height: " + windowHeight);
         }
+        Element parentElement = getElement().getParentElement();
+        if (isMonitoringParentSize() && parentElement != null) {
+            // check also for parent size changes
+            int newParentWidth = parentElement.getClientWidth();
+            int newParentHeight = parentElement.getClientHeight();
+            if (parentWidth != newParentWidth) {
+                parentWidth = newParentWidth;
+                changed = true;
+                VConsole.log("New parent width: " + parentWidth);
+            }
+            if (parentHeight != newParentHeight) {
+                parentHeight = newParentHeight;
+                changed = true;
+                VConsole.log("New parent height: " + parentHeight);
+            }
+        }
         if (changed) {
             /*
              * If the window size has changed, layout the VView again and send
@@ -159,10 +213,19 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
              * should shrink as the content's size is fixed and would thus not
              * automatically shrink.)
              */
-            VConsole.log("Running layout functions due to window resize");
+            VConsole.log("Running layout functions due to window or parent resize");
+
             connection.runDescendentsLayout(VView.this);
             Util.runWebkitOverflowAutoFix(getElement());
 
+            // update size to avoid (most) redundant re-layout passes
+            // there can still be an extra layout recalculation if webkit
+            // overflow fix updates the size in a deferred block
+            if (isMonitoringParentSize() && parentElement != null) {
+                parentWidth = parentElement.getClientWidth();
+                parentHeight = parentElement.getClientHeight();
+            }
+
             sendClientResized();
         }
     }
@@ -206,6 +269,17 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
                 .contains(ApplicationConnection.GENERATED_BODY_CLASSNAME);
     }
 
+    /**
+     * Returns true if the size of the parent should be checked periodically and
+     * the application should react to its changes.
+     * 
+     * @return true if size of parent should be tracked
+     */
+    protected boolean isMonitoringParentSize() {
+        // could also perform a more specific check (Liferay portlet)
+        return isEmbedded();
+    }
+
     public void updateFromUIDL(final UIDL uidl, ApplicationConnection client) {
         rendering = true;
 
@@ -400,7 +474,7 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
             Window.addResizeHandler(this);
         }
 
-        onResize();
+        triggerSizeChangeCheck();
 
         // finally set scroll position from UIDL
         if (uidl.hasVariable("scrollTop")) {
@@ -510,13 +584,17 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
      * .gwt.event.logical.shared.ResizeEvent)
      */
     public void onResize(ResizeEvent event) {
-        onResize();
+        triggerSizeChangeCheck();
     }
 
     /**
      * Called when a resize event is received.
+     * 
+     * This may trigger a lazy refresh or perform the size check immediately
+     * depending on the browser used and whether the server side requests
+     * resizes to be lazy.
      */
-    private void onResize() {
+    private void triggerSizeChangeCheck() {
         /*
          * IE (pre IE9 at least) will give us some false resize events due to
          * problems with scrollbars. Firefox 3 might also produce some extra
@@ -534,8 +612,7 @@ public class VView extends SimplePanel implements Container, ResizeHandler,
         if (lazy) {
             delayedResizeExecutor.trigger();
         } else {
-            windowSizeMaybeChanged(Window.getClientWidth(),
-                    Window.getClientHeight());
+            performSizeCheck();
         }
     }