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

2 files changed, 88 insertions, 0 deletions

diff --git a/uitest/src/com/vaadin/tests/components/ui/UIReinit.java b/uitest/src/com/vaadin/tests/components/ui/UIReinit.java
new file mode 100644
index 0000000000..bef7a5a6d1
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/components/ui/UIReinit.java
@@ -0,0 +1,49 @@
+/*
+ * 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.tests.components.ui;
+
+import com.vaadin.annotations.PreserveOnRefresh;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.tests.components.AbstractTestUI;
+import com.vaadin.ui.Label;
+
+@PreserveOnRefresh
+public class UIReinit extends AbstractTestUI {
+
+    public static final String REINIT_ID = "reinit";
+
+    @Override
+    protected void setup(VaadinRequest request) {
+    }
+
+    @Override
+    protected void reinit(VaadinRequest request) {
+        Label l = new Label("Reinit!");
+        l.setId(REINIT_ID);
+        addComponent(l);
+    }
+
+    @Override
+    public String getTestDescription() {
+        return "UI reinit after refresh";
+    }
+
+    @Override
+    protected Integer getTicketNumber() {
+        return Integer.valueOf(12191);
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/components/ui/UIReinitTest.java b/uitest/src/com/vaadin/tests/components/ui/UIReinitTest.java
new file mode 100644
index 0000000000..82132d3c65
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/components/ui/UIReinitTest.java
@@ -0,0 +1,39 @@
+/*
+ * 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.tests.components.ui;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import com.vaadin.testbench.By;
+import com.vaadin.tests.tb3.MultiBrowserTest;
+
+public class UIReinitTest extends MultiBrowserTest {
+
+    @Test
+    public void testUIReinit() {
+        openTestURL();
+        Assert.assertFalse(reinitLabelExists());
+        // Reload the page; UI.reinit should be invoked
+        openTestURL();
+        Assert.assertTrue(reinitLabelExists());
+    }
+
+    private boolean reinitLabelExists() {
+        return !getDriver().findElements(By.id(UIReinit.REINIT_ID)).isEmpty();
+    }
+}