Add reinit method for preserve-on-refresh UIs (#12191)

UI.reinit() is now called when an existing, preserved UI is shown after a
browser reload of the current page. The default implementation is empty.
The browser window size and location are up to date in UI.reinit();
window resize and URI fragment listeners, if any, will be called after
returning from UI.reinit().

Change-Id: Ie7aa670aaecf8e0e1510c91325b2a137b41263af

1 files changed, 116 insertions, 0 deletions

diff --git a/server/tests/src/com/vaadin/ui/UIInitReinitTest.java b/server/tests/src/com/vaadin/ui/UIInitReinitTest.java
new file mode 100644
index 0000000000..f8ec0e68c2
--- /dev/null
+++ b/server/tests/src/com/vaadin/ui/UIInitReinitTest.java
@@ -0,0 +1,116 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.ui;
+
+import org.easymock.EasyMock;
+import org.easymock.IMocksControl;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import com.vaadin.server.Page.BrowserWindowResizeEvent;
+import com.vaadin.server.Page.BrowserWindowResizeListener;
+import com.vaadin.server.Page.UriFragmentChangedEvent;
+import com.vaadin.server.Page.UriFragmentChangedListener;
+import com.vaadin.server.VaadinRequest;
+
+public class UIInitReinitTest {
+
+    private boolean initCalled;
+    private boolean reinitCalled;
+    private boolean fragmentChangeCalled;
+    private boolean browserWindowResizeCalled;
+
+    private class TestUI extends UI implements UriFragmentChangedListener,
+            BrowserWindowResizeListener {
+        @Override
+        protected void init(VaadinRequest request) {
+            getPage().addBrowserWindowResizeListener(this);
+            getPage().addUriFragmentChangedListener(this);
+
+            initCalled = true;
+
+            Assert.assertEquals("foo", getPage().getUriFragment());
+            Assert.assertEquals(100, getPage().getBrowserWindowWidth());
+            Assert.assertEquals(100, getPage().getBrowserWindowHeight());
+
+            Assert.assertFalse(fragmentChangeCalled);
+            Assert.assertFalse(browserWindowResizeCalled);
+        }
+
+        @Override
+        protected void reinit(VaadinRequest request) {
+            reinitCalled = true;
+
+            Assert.assertEquals("bar", getPage().getUriFragment());
+            Assert.assertEquals(200, getPage().getBrowserWindowWidth());
+            Assert.assertEquals(200, getPage().getBrowserWindowHeight());
+
+            Assert.assertFalse(fragmentChangeCalled);
+            Assert.assertFalse(browserWindowResizeCalled);
+        }
+
+        @Override
+        public void browserWindowResized(BrowserWindowResizeEvent event) {
+            Assert.assertEquals(200, event.getWidth());
+            Assert.assertEquals(200, event.getHeight());
+            browserWindowResizeCalled = true;
+        }
+
+        @Override
+        public void uriFragmentChanged(UriFragmentChangedEvent event) {
+            Assert.assertEquals("bar", event.getUriFragment());
+            fragmentChangeCalled = true;
+        }
+    };
+
+    @Before
+    public void setUp() {
+        initCalled = reinitCalled = fragmentChangeCalled = browserWindowResizeCalled = false;
+    }
+
+    @Test
+    public void testListenersCalled() {
+        IMocksControl control = EasyMock.createNiceControl();
+
+        VaadinRequest initRequest = control.createMock(VaadinRequest.class);
+        EasyMock.expect(initRequest.getParameter("v-loc")).andReturn(
+                "http://example.com/#foo");
+        EasyMock.expect(initRequest.getParameter("v-cw")).andReturn("100");
+        EasyMock.expect(initRequest.getParameter("v-ch")).andReturn("100");
+
+        VaadinRequest reinitRequest = control.createMock(VaadinRequest.class);
+        EasyMock.expect(reinitRequest.getParameter("v-loc")).andReturn(
+                "http://example.com/#bar");
+        EasyMock.expect(reinitRequest.getParameter("v-cw")).andReturn("200");
+        EasyMock.expect(reinitRequest.getParameter("v-ch")).andReturn("200");
+
+        control.replay();
+
+        UI ui = new TestUI();
+        ui.doInit(initRequest, 0, "");
+
+        Assert.assertTrue(initCalled);
+        Assert.assertFalse(fragmentChangeCalled);
+        Assert.assertFalse(browserWindowResizeCalled);
+
+        ui.doReinit(reinitRequest);
+
+        Assert.assertTrue(reinitCalled);
+        Assert.assertTrue(fragmentChangeCalled);
+        Assert.assertTrue(browserWindowResizeCalled);
+    }
+}