Avoid eagerly layouting from VScrollTable.updateFromUIDL (#13188)

Closing a modal sub-window at the same time when TreeTable item is
removed, caused the detached Window being re-opened by
WindowConnector.postLayout() call.

This change adds a check in postLayout: continue operation only if the
window is attached to DOM. Or else, log a warning message about the
invalid postLayout call. Another change is in TreeTableConnector and
VScrollTable to disallow Util.notifyParentOfSizeChange(Widget, boolean)
with a boolean 'false' argument, when rendering is in progress. 'false'
causes an immediate LayoutManager.layoutNow() call, which is the main
reason for this issue.

Change-Id: I6f3e331b0feff9e7814ae1d749f6f7812dcd49ac

2 files changed, 210 insertions, 0 deletions

diff --git a/uitest/src/com/vaadin/tests/components/window/CloseModalSubWindow.java b/uitest/src/com/vaadin/tests/components/window/CloseModalSubWindow.java
new file mode 100644
index 0000000000..44239ba649
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/components/window/CloseModalSubWindow.java
@@ -0,0 +1,135 @@
+/*
+ * 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.window;
+
+import com.vaadin.data.Item;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.tests.components.AbstractTestUIWithLog;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.Button.ClickEvent;
+import com.vaadin.ui.Button.ClickListener;
+import com.vaadin.ui.HorizontalLayout;
+import com.vaadin.ui.TreeTable;
+import com.vaadin.ui.UI;
+import com.vaadin.ui.Window;
+
+@SuppressWarnings("serial")
+public class CloseModalSubWindow extends AbstractTestUIWithLog {
+
+    public static final String SUB_WINDOW = "sub-win";
+    public static final String TREE_TABLE = "treetable";
+    public static final String DELETE_BUTTON = "del-btn";
+    public static final String CONFIRM_BUTTON = "confirm-btn";
+
+    private ConfirmWindow win;
+
+    private TreeTable table;
+
+    @Override
+    protected String getTestDescription() {
+        return "Lists a dozen items in a TreeTable with a Delete Button in each row. "
+                + "Delete button will open an sub-window allowing user to either confirm delete operation or cancel. "
+                + "Confirming should close the sub-window at the same time as the item is removed from the TreeTable.";
+    }
+
+    @Override
+    protected Integer getTicketNumber() {
+        return 13188;
+    }
+
+    @SuppressWarnings("unchecked")
+    @Override
+    protected void setup(VaadinRequest request) {
+        table = new TreeTable();
+        table.setId(TREE_TABLE);
+        table.addContainerProperty("column", String.class, null);
+        table.addContainerProperty("delete", Button.class, null);
+
+        for (int i = 0; i < 10; i++) {
+            Item item = table.addItem(i);
+            item.getItemProperty("column").setValue("" + i);
+
+            Button b = new Button("Delete", deleteClickListener);
+            b.setId(DELETE_BUTTON + i);
+            b.setData(i);
+            item.getItemProperty("delete").setValue(b);
+        }
+
+        table.setSortEnabled(false);
+        table.setColumnReorderingAllowed(false);
+        table.setEditable(true);
+        table.setPageLength(0);
+
+        addComponent(table);
+
+    }
+
+    private void deleteItem(Object itemId) {
+        table.removeItem(itemId);
+    }
+
+    private ClickListener deleteClickListener = new ClickListener() {
+
+        @Override
+        public void buttonClick(ClickEvent event) {
+            win = new ConfirmWindow(event.getButton().getData());
+            log("Modal sub-window opened");
+        }
+    };
+
+    private ClickListener confirmClickListener = new ClickListener() {
+
+        @Override
+        public void buttonClick(ClickEvent event) {
+            deleteItem(event.getButton().getData());
+            win.close();
+            log("Modal sub-window closed");
+        }
+    };
+
+    private ClickListener cancelClickListener = new ClickListener() {
+
+        @Override
+        public void buttonClick(ClickEvent event) {
+            win.close();
+            log("Modal sub-window closed");
+        }
+    };
+
+    /** Modal confirmation sub-window. */
+    class ConfirmWindow extends Window {
+
+        public ConfirmWindow(Object itemId) {
+            setModal(true);
+            setWidth("300px");
+            setHeight("200px");
+            setId(SUB_WINDOW);
+
+            Button ok = new Button("Confirm Delete", confirmClickListener);
+            ok.setId(CONFIRM_BUTTON);
+            ok.setData(itemId);
+            Button cancel = new Button("Cancel", cancelClickListener);
+
+            HorizontalLayout l = new HorizontalLayout();
+            l.addComponent(ok);
+            l.addComponent(cancel);
+
+            setContent(l);
+
+            UI.getCurrent().addWindow(this);
+        }
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/components/window/CloseModalSubWindowTest.java b/uitest/src/com/vaadin/tests/components/window/CloseModalSubWindowTest.java
new file mode 100644
index 0000000000..6c50c01277
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/components/window/CloseModalSubWindowTest.java
@@ -0,0 +1,75 @@
+/*
+ * 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.window;
+
+import java.util.List;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.openqa.selenium.By;
+import org.openqa.selenium.WebElement;
+
+import com.vaadin.tests.tb3.MultiBrowserTest;
+
+public class CloseModalSubWindowTest extends MultiBrowserTest {
+
+    @Test
+    public void testCloseModalSubWindow() throws Exception {
+
+        openTestURL();
+
+        // assert that there's a button with a 'del-btn0' id
+        List<WebElement> buttons = getDriver().findElements(
+                By.id(CloseModalSubWindow.DELETE_BUTTON + "0"));
+        int deleteButtonCount = buttons.size();
+        Assert.assertEquals(1, deleteButtonCount);
+
+        // assert that there's no sub-windows open
+        List<WebElement> subWindows = getDriver().findElements(
+                By.id(CloseModalSubWindow.SUB_WINDOW));
+        Assert.assertEquals(0, subWindows.size());
+
+        // click the first delete button
+        getFirstDeteleButton(0).click();
+
+        // assert that there's ONE sub-window open
+        subWindows = getDriver().findElements(
+                By.id(CloseModalSubWindow.SUB_WINDOW));
+        Assert.assertEquals(1, subWindows.size());
+
+        WebElement confirm = getDriver().findElement(
+                By.id(CloseModalSubWindow.CONFIRM_BUTTON));
+
+        // click the confirm button in the sub-window
+        confirm.click();
+
+        // assert that there's no sub-windows open
+        subWindows = getDriver().findElements(
+                By.id(CloseModalSubWindow.SUB_WINDOW));
+        Assert.assertEquals(0, subWindows.size());
+
+        // assert that there's no button with 'del-btn0' id anymore
+        buttons = getDriver().findElements(
+                By.id(CloseModalSubWindow.DELETE_BUTTON + "0"));
+        Assert.assertEquals(0, buttons.size());
+    }
+
+    private WebElement getFirstDeteleButton(int index) {
+        WebElement button = getDriver().findElement(
+                By.id(CloseModalSubWindow.DELETE_BUTTON + index));
+        return button;
+    }
+}