Changed grid sidebar to overlay (#18698)

Previously grid sidebar could be partially hidden by
"overflow: hidden" of an ancestor component.
Now it's in an overlay and the hierarchy doesn't affect it.
Grid tests were also updated for new DOM structure.

Change-Id: Ic5fb125d9c097be0f0141c121dfe74d30e650dd0

5 files changed, 97 insertions, 41 deletions

diff --git a/uitest/src/com/vaadin/tests/components/grid/GridInGridLayout.java b/uitest/src/com/vaadin/tests/components/grid/GridInGridLayout.java
new file mode 100644
index 0000000000..629eba9045
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/components/grid/GridInGridLayout.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2000-2014 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.grid;
+
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.tests.components.AbstractTestUI;
+import com.vaadin.ui.CssLayout;
+import com.vaadin.ui.Grid;
+import com.vaadin.ui.VerticalLayout;
+
+public class GridInGridLayout extends AbstractTestUI {
+
+    @Override
+    protected void setup(VaadinRequest request) {
+        final VerticalLayout layout = new VerticalLayout();
+        final CssLayout cssLayout = new CssLayout();
+        cssLayout.setWidth("100%");
+        layout.setHeight("320px");
+        layout.setMargin(true);
+        addComponent(cssLayout);
+        cssLayout.addComponent(layout);
+
+        final Grid grid = new Grid();
+        grid.setSizeFull();
+        for (int i = 0; i < 20; i++) {
+            Grid.Column column = grid.addColumn("" + i);
+            column.setHidable(true);
+            column.setEditable(true);
+        }
+        grid.setEditorEnabled(true);
+        grid.setColumnReorderingAllowed(true);
+        for (int i = 0; i < 300; i++) {
+            grid.addRow("Foo", "Bar", "far", "bar", "bar", "Foo", "Bar", "Bar",
+                    "bar", "bar", "Foo", "Bar", "Bar", "bar", "bar", "Foo",
+                    "Bar", "Bar", "bar", "bar");
+
+        }
+        layout.addComponent(grid);
+        grid.setHeight("300px");
+        grid.setWidth("400px");
+    }
+
+    @Override
+    protected Integer getTicketNumber() {
+        return 18698;
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/components/grid/GridInitiallyHiddenColumnsTest.java b/uitest/src/com/vaadin/tests/components/grid/GridInitiallyHiddenColumnsTest.java
index f495d7f2aa..732cd4aa41 100644
--- a/uitest/src/com/vaadin/tests/components/grid/GridInitiallyHiddenColumnsTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/GridInitiallyHiddenColumnsTest.java
@@ -50,6 +50,8 @@ public class GridInitiallyHiddenColumnsTest extends SingleBrowserTest {
 
     }
 
+    // TODO: as to the getX methods reuse ones from GridBasicFeaturesTest?
+
     protected WebElement getSidebarOpenButton(GridElement grid) {
         List<WebElement> elements = grid.findElements(By
                 .className("v-grid-sidebar-button"));
@@ -73,7 +75,8 @@ public class GridInitiallyHiddenColumnsTest extends SingleBrowserTest {
     }
 
     protected WebElement getSidebar(GridElement grid) {
-        List<WebElement> elements = findElements(By.className("v-grid-sidebar"));
+        List<WebElement> elements = findElements(By
+                .className("v-grid-sidebar-popup"));
         return elements.isEmpty() ? null : elements.get(0);
     }
 
diff --git a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicFeaturesTest.java b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicFeaturesTest.java
index a0eb8dfefe..640c4a448b 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicFeaturesTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicFeaturesTest.java
@@ -217,8 +217,19 @@ public abstract class GridBasicFeaturesTest extends MultiBrowserTest {
                 .contains("focused"));
     }
 
-    protected WebElement getSidebar() {
-        List<WebElement> elements = findElements(By.className("v-grid-sidebar"));
+    protected WebElement getSidebarPopup() {
+        List<WebElement> elements = findElements(By
+                .className("v-grid-sidebar-popup"));
+        if (elements.isEmpty()) {
+            getSidebarOpenButton().click();
+            elements = findElements(By.className("v-grid-sidebar-popup"));
+        }
+        return elements.isEmpty() ? null : elements.get(0);
+    }
+
+    protected WebElement getSidebarPopupIfPresent() {
+        List<WebElement> elements = findElements(By
+                .className("v-grid-sidebar-popup"));
         return elements.isEmpty() ? null : elements.get(0);
     }
 
@@ -233,7 +244,7 @@ public abstract class GridBasicFeaturesTest extends MultiBrowserTest {
      * index, or null if not found.
      */
     protected WebElement getColumnHidingToggle(int columnIndex) {
-        WebElement sidebar = getSidebar();
+        WebElement sidebar = getSidebarPopup();
         List<WebElement> elements = sidebar.findElements(By
                 .className("column-hiding-toggle"));
         for (WebElement e : elements) {
diff --git a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java
index a169e701c0..02e94ec6c4 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java
@@ -188,12 +188,12 @@ public class GridColumnHidingTest extends GridBasicClientFeaturesTest {
 
     @Test
     public void testColumnHidability_onTriggerColumnHidability_showsSidebarButton() {
-        WebElement sidebar = getSidebar();
+        WebElement sidebar = getSidebarOpenButton();
         assertNull(sidebar);
 
         toggleHidableColumnAPI(0);
 
-        sidebar = getSidebar();
+        sidebar = getSidebarOpenButton();
         assertNotNull(sidebar);
     }
 
@@ -998,7 +998,7 @@ public class GridColumnHidingTest extends GridBasicClientFeaturesTest {
     }
 
     private void verifyColumnHidingTogglesOrder(int... indices) {
-        WebElement sidebar = getSidebar();
+        WebElement sidebar = getSidebarPopup();
         List<WebElement> elements = sidebar.findElements(By
                 .className("column-hiding-toggle"));
         for (int i = 0; i < indices.length; i++) {
@@ -1015,45 +1015,32 @@ public class GridColumnHidingTest extends GridBasicClientFeaturesTest {
     }
 
     private void verifySidebarOpened() {
-        WebElement sidebar = getSidebar();
-        assertTrue(sidebar.getAttribute("class").contains("open"));
+        WebElement sidebar = getSidebarPopupIfPresent();
+        assertNotNull(sidebar);
     }
 
     private void verifySidebarClosed() {
-        WebElement sidebar = getSidebar();
-        assertFalse(sidebar.getAttribute("class").contains("open"));
+        WebElement sidebar = getSidebarPopupIfPresent();
+        assertNull(sidebar);
     }
 
     private void verifySidebarNotVisible() {
-        WebElement sidebar = getSidebar();
+        WebElement sidebar = getSidebarOpenButton();
         assertNull(sidebar);
     }
 
     private void verifySidebarVisible() {
-        WebElement sidebar = getSidebar();
+        WebElement sidebar = getSidebarOpenButton();
         assertNotNull(sidebar);
     }
 
-    @Override
-    protected WebElement getSidebar() {
-        List<WebElement> elements = findElements(By.className("v-grid-sidebar"));
-        return elements.isEmpty() ? null : elements.get(0);
-    }
-
-    @Override
-    protected WebElement getSidebarOpenButton() {
-        List<WebElement> elements = findElements(By
-                .className("v-grid-sidebar-button"));
-        return elements.isEmpty() ? null : elements.get(0);
-    }
-
     /**
      * Returns the toggle inside the sidebar for hiding the column at the given
      * index, or null if not found.
      */
     @Override
     protected WebElement getColumnHidingToggle(int columnIndex) {
-        WebElement sidebar = getSidebar();
+        WebElement sidebar = getSidebarPopup();
         List<WebElement> elements = sidebar.findElements(By
                 .className("column-hiding-toggle"));
         for (WebElement e : elements) {
diff --git a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/client/GridSidebarContentTest.java b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/client/GridSidebarContentTest.java
index 619dd5ae12..1b9d1a0728 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/client/GridSidebarContentTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/client/GridSidebarContentTest.java
@@ -30,24 +30,23 @@ public class GridSidebarContentTest extends GridBasicClientFeaturesTest {
     @Test
     public void testSidebarWithHidableColumn() {
         openTestURL();
-        CustomGridElement gridElement = getGridElement();
 
         Assert.assertEquals("Sidebar should not be initially present", 0,
-                countBySelector(".v-grid-sidebar"));
+                countBySelector(".v-grid-sidebar-button"));
 
         selectMenuPath("Component", "Columns", "Column 0", "Hidable");
 
-        gridElement.findElement(By.className("v-grid-sidebar-button")).click();
+        getSidebarOpenButton().click();
 
-        WebElement toggle = gridElement.findElement(By
-                .className("column-hiding-toggle"));
+        WebElement toggle = getSidebarPopup().findElement(
+                By.className("column-hiding-toggle"));
 
         Assert.assertEquals("Column 0 should be togglable", "Header (0,0)",
                 toggle.getText());
 
         selectMenuPath("Component", "Columns", "Column 0", "Hidable");
         Assert.assertEquals("Sidebar should disappear without toggable column",
-                0, countBySelector(".v-grid-sidebar"));
+                0, countBySelector(".v-grid-sidebar-button"));
 
     }
 
@@ -60,8 +59,8 @@ public class GridSidebarContentTest extends GridBasicClientFeaturesTest {
 
         gridElement.findElement(By.className("v-grid-sidebar-button")).click();
 
-        WebElement sidebarItem = gridElement.findElement(By
-                .cssSelector(".v-grid-sidebar-content .gwt-MenuItem"));
+        WebElement sidebarItem = getSidebarPopup().findElement(
+                By.cssSelector(".v-grid-sidebar-content .gwt-MenuItem"));
 
         sidebarItem.click();
 
@@ -84,7 +83,6 @@ public class GridSidebarContentTest extends GridBasicClientFeaturesTest {
     @Test
     public void testBasicSidebarOrder() {
         openTestURL();
-        CustomGridElement gridElement = getGridElement();
 
         // First add custom content
         selectMenuPath("Component", "Sidebar", "Add separator to end");
@@ -101,7 +99,6 @@ public class GridSidebarContentTest extends GridBasicClientFeaturesTest {
     @Test
     public void testSidebarOrderAbuse() {
         openTestURL();
-        CustomGridElement gridElement = getGridElement();
 
         selectMenuPath("Component", "Columns", "Column 0", "Hidable");
         selectMenuPath("Component", "Columns", "Column 1", "Hidable");
@@ -125,7 +122,7 @@ public class GridSidebarContentTest extends GridBasicClientFeaturesTest {
     }
 
     private void assertSidebarMenuItems(String... items) {
-        List<WebElement> menuItems = getGridElement().findElements(
+        List<WebElement> menuItems = getSidebarPopup().findElements(
                 By.cssSelector(".v-grid-sidebar-content td"));
 
         Assert.assertEquals("Expected " + items.length + " menu items",
@@ -145,8 +142,6 @@ public class GridSidebarContentTest extends GridBasicClientFeaturesTest {
     }
 
     private int countBySelector(String cssSelector) {
-        return getGridElement().findElements(By.cssSelector(cssSelector))
-                .size();
+        return findElements(By.cssSelector(cssSelector)).size();
     }
-
 }