Merge remote-tracking branch 'origin/grid-columnhiding' into grid-7.5

Change-Id: Ice80ed9d5a96d9de824cc932873b4e6a736459a8

4 files changed, 395 insertions, 24 deletions

diff --git a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicClientFeaturesTest.java b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicClientFeaturesTest.java
index 5d02189787..754529d10d 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicClientFeaturesTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicClientFeaturesTest.java
@@ -99,4 +99,9 @@ public abstract class GridBasicClientFeaturesTest extends GridBasicFeaturesTest
             assertColumnHeader("HEADER (0," + indices[i] + ")", headers.get(i));
         }
     }
+
+    protected void toggleColumnReorder() {
+        selectMenuPath("Component", "State", "Column Reordering");
+    }
+
 }
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 6d38c25fb6..87af43af12 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java
@@ -16,9 +16,15 @@
 package com.vaadin.tests.components.grid.basicfeatures;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import java.util.List;
 
 import org.junit.Before;
+import org.junit.Ignore;
 import org.junit.Test;
 import org.openqa.selenium.By;
 import org.openqa.selenium.WebElement;
@@ -38,12 +44,12 @@ public class GridColumnHidingTest extends GridBasicClientFeaturesTest {
         selectMenuPath("Component", "State", "Width", "1000px");
         assertColumnHeaderOrder(0, 1, 2, 3, 4, 5, 6);
 
-        toggleHideColumn(0);
+        toggleHideColumnAPI(0);
         assertColumnHeaderOrder(1, 2, 3, 4, 5, 6);
 
-        toggleHideColumn(1);
-        toggleHideColumn(2);
-        toggleHideColumn(3);
+        toggleHideColumnAPI(1);
+        toggleHideColumnAPI(2);
+        toggleHideColumnAPI(3);
         assertColumnHeaderOrder(4, 5, 6, 7, 8);
     }
 
@@ -52,19 +58,19 @@ public class GridColumnHidingTest extends GridBasicClientFeaturesTest {
         selectMenuPath("Component", "State", "Width", "1000px");
         assertColumnHeaderOrder(0, 1, 2, 3, 4, 5, 6);
 
-        toggleHideColumn(0);
+        toggleHideColumnAPI(0);
         assertColumnHeaderOrder(1, 2, 3, 4, 5, 6);
 
-        toggleHideColumn(0);
+        toggleHideColumnAPI(0);
         assertColumnHeaderOrder(0, 1, 2, 3, 4, 5, 6);
 
-        toggleHideColumn(1);
-        toggleHideColumn(2);
-        toggleHideColumn(3);
+        toggleHideColumnAPI(1);
+        toggleHideColumnAPI(2);
+        toggleHideColumnAPI(3);
         assertColumnHeaderOrder(0, 4, 5, 6, 7, 8);
 
-        toggleHideColumn(1);
-        toggleHideColumn(2);
+        toggleHideColumnAPI(1);
+        toggleHideColumnAPI(2);
         assertColumnHeaderOrder(0, 1, 2, 4, 5, 6);
     }
 
@@ -73,26 +79,26 @@ public class GridColumnHidingTest extends GridBasicClientFeaturesTest {
         selectMenuPath("Component", "State", "Width", "1000px");
         assertColumnHeaderOrder(0, 1, 2, 3, 4, 5, 6);
 
-        toggleHideColumn(2);
+        toggleHideColumnAPI(2);
         assertColumnHeaderOrder(0, 1, 3, 4, 5, 6);
 
-        toggleHideColumn(2);
+        toggleHideColumnAPI(2);
         assertColumnHeaderOrder(0, 1, 2, 3, 4, 5, 6);
 
-        toggleHideColumn(2);
+        toggleHideColumnAPI(2);
         assertColumnHeaderOrder(0, 1, 3, 4, 5, 6);
 
-        toggleHideColumn(2);
+        toggleHideColumnAPI(2);
         assertColumnHeaderOrder(0, 1, 2, 3, 4, 5, 6);
     }
 
     @Test
-    public void testColumnHiding_onVisibilityChange_triggersClientSideEvent() {
+    public void testColumnHiding_changeVisibilityAPI_triggersClientSideEvent() {
         assertColumnHeaderOrder(0, 1, 2, 3, 4);
         selectMenuPath("Component", "Internals", "Listeners",
                 "Add Column Visibility Change listener");
 
-        toggleHideColumn(2);
+        toggleHideColumnAPI(2);
         assertColumnHeaderOrder(0, 1, 3, 4);
 
         WebElement webElement = findElement(By.id("columnvisibility"));
@@ -110,7 +116,7 @@ public class GridColumnHidingTest extends GridBasicClientFeaturesTest {
         assertEquals(false, userOriginated);
         assertEquals(true, hidden);
 
-        toggleHideColumn(2);
+        toggleHideColumnAPI(2);
         assertColumnHeaderOrder(0, 1, 2, 3, 4);
 
         webElement = findElement(By.id("columnvisibility"));
@@ -127,7 +133,366 @@ public class GridColumnHidingTest extends GridBasicClientFeaturesTest {
         assertEquals(false, hidden);
     }
 
-    private void toggleHideColumn(int columnIndex) {
+    @Test
+    public void testColumnHiding_changeVisibilityToggle_triggersClientSideEvent() {
+        assertColumnHeaderOrder(0, 1, 2, 3, 4);
+        selectMenuPath("Component", "Internals", "Listeners",
+                "Add Column Visibility Change listener");
+
+        toggleHidableColumnAPI(2);
+        clickSidebarOpenButton();
+        getColumnHidingToggle(2).click();
+        assertColumnHeaderOrder(0, 1, 3, 4);
+
+        WebElement webElement = findElement(By.id("columnvisibility"));
+        int counter = Integer.parseInt(webElement.getAttribute("counter"));
+        int columnIndex = Integer.parseInt(webElement
+                .getAttribute("columnindex"));
+        boolean userOriginated = Boolean.parseBoolean(webElement
+                .getAttribute("useroriginated"));
+        boolean hidden = Boolean.parseBoolean(webElement
+                .getAttribute("ishidden"));
+
+        assertNotNull("no event fired", webElement);
+        assertEquals(1, counter);
+        assertEquals(2, columnIndex);
+        assertEquals(true, userOriginated);
+        assertEquals(true, hidden);
+
+        getColumnHidingToggle(2).click();
+        assertColumnHeaderOrder(0, 1, 2, 3, 4);
+
+        webElement = findElement(By.id("columnvisibility"));
+        counter = Integer.parseInt(webElement.getAttribute("counter"));
+        columnIndex = Integer.parseInt(webElement.getAttribute("columnIndex"));
+        userOriginated = Boolean.parseBoolean(webElement
+                .getAttribute("userOriginated"));
+        hidden = Boolean.parseBoolean(webElement.getAttribute("ishidden"));
+
+        assertNotNull("no event fired", webElement);
+        assertEquals(2, counter);
+        assertEquals(2, columnIndex);
+        assertEquals(true, userOriginated);
+        assertEquals(false, hidden);
+    }
+
+    @Test
+    public void testColumnHidability_onTriggerColumnHidability_showsSidebarButton() {
+        WebElement sidebar = getSidebar();
+        assertNull(sidebar);
+
+        toggleHidableColumnAPI(0);
+
+        sidebar = getSidebar();
+        assertNotNull(sidebar);
+    }
+
+    @Test
+    public void testColumnHidability_triggeringColumnHidabilityWithSeveralColumns_showsAndHidesSiderbarButton() {
+        verifySidebarNotVisible();
+
+        toggleHidableColumnAPI(3);
+        toggleHidableColumnAPI(4);
+
+        verifySidebarVisible();
+
+        toggleHidableColumnAPI(3);
+
+        verifySidebarVisible();
+
+        toggleHidableColumnAPI(4);
+
+        verifySidebarNotVisible();
+    }
+
+    @Test
+    public void testColumnHidability_clickingSidebarButton_opensClosesSidebar() {
+        toggleHidableColumnAPI(0);
+        verifySidebarClosed();
+
+        clickSidebarOpenButton();
+
+        verifySidebarOpened();
+
+        clickSidebarOpenButton();
+
+        verifySidebarClosed();
+    }
+
+    @Test
+    public void testColumnHidability_settingColumnHidable_showsToggleInSidebar() {
+        toggleHidableColumnAPI(0);
+        verifySidebarClosed();
+        clickSidebarOpenButton();
+        verifySidebarOpened();
+
+        verifyColumnHidingOption(0, false);
+    }
+
+    @Test
+    public void testColumnHiding_hidingColumnWithToggle_works() {
+        assertColumnHeaderOrder(0, 1, 2, 3, 4);
+        toggleHidableColumnAPI(0);
+        verifySidebarClosed();
+        clickSidebarOpenButton();
+        verifySidebarOpened();
+        verifyColumnHidingOption(0, false);
+
+        getColumnHidingToggle(0).click();
+        verifyColumnHidingOption(0, true);
+        assertColumnHeaderOrder(1, 2, 3, 4);
+
+        getColumnHidingToggle(0).click();
+        verifyColumnHidingOption(0, false);
+        assertColumnHeaderOrder(0, 1, 2, 3, 4);
+    }
+
+    @Test
+    public void testColumnHiding_updatingHiddenWhileSidebarClosed_updatesToggleValue() {
+        toggleHidableColumnAPI(0);
+        toggleHidableColumnAPI(3);
+        toggleHideColumnAPI(3);
+        assertColumnHeaderOrder(0, 1, 2, 4);
+        verifySidebarClosed();
+
+        clickSidebarOpenButton();
+        verifySidebarOpened();
+        verifyColumnHidingOption(0, false);
+        verifyColumnHidingOption(3, true);
+
+        clickSidebarOpenButton();
+        verifySidebarClosed();
+
+        toggleHideColumnAPI(0);
+        toggleHideColumnAPI(3);
+
+        clickSidebarOpenButton();
+        verifySidebarOpened();
+        verifyColumnHidingOption(0, true);
+        verifyColumnHidingOption(3, false);
+
+    }
+
+    @Test
+    public void testColumnHiding_hidingMultipleColumnsWithToggle_hidesColumns() {
+        assertColumnHeaderOrder(0, 1, 2, 3, 4);
+
+        toggleHideColumnAPI(1);
+        toggleHidableColumnAPI(0);
+        toggleHidableColumnAPI(1);
+        toggleHidableColumnAPI(2);
+        toggleHidableColumnAPI(3);
+        toggleHidableColumnAPI(4);
+        verifySidebarClosed();
+        assertColumnHeaderOrder(0, 2, 3, 4);
+
+        clickSidebarOpenButton();
+        verifySidebarOpened();
+        verifyColumnHidingOption(0, false);
+        verifyColumnHidingOption(1, true);
+        verifyColumnHidingOption(2, false);
+        verifyColumnHidingOption(3, false);
+        verifyColumnHidingOption(4, false);
+
+        // must be done in a funny order so that the header indexes won't break
+        // (because of data source uses counter)
+        getColumnHidingToggle(1).click();
+        getColumnHidingToggle(2).click();
+        getColumnHidingToggle(3).click();
+        getColumnHidingToggle(4).click();
+        getColumnHidingToggle(0).click();
+        verifyColumnHidingOption(0, true);
+        verifyColumnHidingOption(1, false);
+        verifyColumnHidingOption(2, true);
+        verifyColumnHidingOption(3, true);
+        verifyColumnHidingOption(4, true);
+
+        assertColumnHeaderOrder(1, 5, 6, 7);
+
+        getColumnHidingToggle(0).click();
+        getColumnHidingToggle(2).click();
+        getColumnHidingToggle(1).click();
+        verifyColumnHidingOption(0, false);
+        verifyColumnHidingOption(1, true);
+        verifyColumnHidingOption(2, false);
+        assertColumnHeaderOrder(0, 2, 5, 6);
+    }
+
+    @Test
+    public void testColumnHidability_changingHidabilityWhenSidebarClosed_addsRemovesToggles() {
+        toggleHideColumnAPI(0);
+        toggleHideColumnAPI(4);
+        assertColumnHeaderOrder(1, 2, 3, 5);
+        toggleHidableColumnAPI(0);
+        toggleHidableColumnAPI(3);
+        toggleHidableColumnAPI(4);
+        verifySidebarClosed();
+
+        clickSidebarOpenButton();
+        verifySidebarOpened();
+        verifyColumnHidingOption(0, true);
+        verifyColumnHidingOption(3, false);
+        verifyColumnHidingOption(4, true);
+
+        clickSidebarOpenButton();
+        verifySidebarClosed();
+
+        toggleHidableColumnAPI(0);
+        toggleHidableColumnAPI(3);
+
+        verifySidebarClosed();
+        clickSidebarOpenButton();
+        verifySidebarOpened();
+        verifyColumnHidingOption(4, true);
+
+        assertNull(getColumnHidingToggle(0));
+        assertNull(getColumnHidingToggle(3));
+    }
+
+    @Test
+    public void testColumnHidability_togglingHidability_placesTogglesInRightOrder() {
+        toggleHidableColumnAPI(3);
+        toggleHidableColumnAPI(2);
+        clickSidebarOpenButton();
+
+        verifyColumnHidingTogglesOrder(2, 3);
+
+        toggleHidableColumnAPI(1);
+        toggleHidableColumnAPI(2);
+        toggleHidableColumnAPI(6);
+        toggleHidableColumnAPI(0);
+
+        verifyColumnHidingTogglesOrder(0, 1, 3, 6);
+
+        clickSidebarOpenButton();
+
+        toggleHidableColumnAPI(2);
+        toggleHidableColumnAPI(4);
+        toggleHidableColumnAPI(7);
+
+        clickSidebarOpenButton();
+
+        verifyColumnHidingTogglesOrder(0, 1, 2, 3, 4, 6, 7);
+    }
+
+    @Test
+    public void testColumnHidability_reorderingColumns_updatesColumnToggleOrder() {
+        selectMenuPath("Component", "State", "Width", "1000px");
+        toggleHidableColumnAPI(0);
+        toggleHidableColumnAPI(1);
+        toggleHidableColumnAPI(3);
+        toggleHidableColumnAPI(4);
+        clickSidebarOpenButton();
+        verifyColumnHidingTogglesOrder(0, 1, 3, 4);
+        clickSidebarOpenButton();
+
+        toggleColumnReorder();
+        dragAndDropColumnHeader(0, 3, 0, 5);
+
+        assertColumnHeaderOrder(3, 0, 1, 2, 4);
+        clickSidebarOpenButton();
+        verifyColumnHidingTogglesOrder(3, 0, 1, 4);
+
+        clickSidebarOpenButton();
+        dragAndDropColumnHeader(0, 1, 3, 100);
+        dragAndDropColumnHeader(0, 4, 0, 5);
+        dragAndDropColumnHeader(0, 3, 0, 5);
+
+        assertColumnHeaderOrder(2, 4, 3, 1, 0);
+        clickSidebarOpenButton();
+        verifyColumnHidingTogglesOrder(4, 3, 1, 0);
+    }
+
+    // know issue, will be fixed in next patch
+    @Test
+    @Ignore
+    public void testColumnHidingAndReorder_reorderingOverHiddenColumns_orderIsKept() {
+        toggleColumnReorder();
+        toggleHideColumnAPI(0);
+        assertColumnHeaderOrder(1, 2, 3, 4, 5);
+
+        dragAndDropColumnHeader(0, 1, 0, 5);
+        assertColumnHeaderOrder(2, 1, 3, 4, 5);
+
+        toggleHideColumnAPI(0);
+        assertColumnHeaderOrder(0, 2, 1, 3, 4, 5);
+    }
+
+    private void verifyColumnHidingTogglesOrder(int... indices) {
+        WebElement sidebar = getSidebar();
+        List<WebElement> elements = sidebar.findElements(By
+                .className("column-hiding-toggle"));
+        for (int i = 0; i < indices.length; i++) {
+            WebElement e = elements.get(i);
+            assertTrue(("Header (0," + indices[i] + ")").equalsIgnoreCase(e
+                    .getText()));
+        }
+    }
+
+    private void verifyColumnHidingOption(int columnIndex, boolean hidden) {
+        WebElement columnHidingToggle = getColumnHidingToggle(columnIndex);
+        assertEquals(hidden,
+                columnHidingToggle.getAttribute("class").contains("hidden"));
+    }
+
+    private void verifySidebarOpened() {
+        WebElement sidebar = getSidebar();
+        assertTrue(sidebar.getAttribute("class").contains("opened"));
+    }
+
+    private void verifySidebarClosed() {
+        WebElement sidebar = getSidebar();
+        assertFalse(sidebar.getAttribute("class").contains("opened"));
+    }
+
+    private void verifySidebarNotVisible() {
+        WebElement sidebar = getSidebar();
+        assertNull(sidebar);
+    }
+
+    private void verifySidebarVisible() {
+        WebElement sidebar = getSidebar();
+        assertNotNull(sidebar);
+    }
+
+    private WebElement getSidebar() {
+        List<WebElement> elements = findElements(By.className("v-grid-sidebar"));
+        return elements.isEmpty() ? null : elements.get(0);
+    }
+
+    private 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.
+     */
+    private WebElement getColumnHidingToggle(int columnIndex) {
+        WebElement sidebar = getSidebar();
+        List<WebElement> elements = sidebar.findElements(By
+                .className("column-hiding-toggle"));
+        for (WebElement e : elements) {
+            if (("Header (0," + columnIndex + ")")
+                    .equalsIgnoreCase(e.getText())) {
+                return e;
+            }
+        }
+        return null;
+    }
+
+    private void clickSidebarOpenButton() {
+        getSidebarOpenButton().click();
+    }
+
+    private void toggleHidableColumnAPI(int columnIndex) {
+        selectMenuPath("Component", "Columns", "Column " + columnIndex,
+                "Hidable");
+    }
+
+    private void toggleHideColumnAPI(int columnIndex) {
         selectMenuPath("Component", "Columns", "Column " + columnIndex,
                 "Hidden");
     }
diff --git a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnReorderTest.java b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnReorderTest.java
index 27e98bf460..a79a954faa 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnReorderTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnReorderTest.java
@@ -601,10 +601,6 @@ public class GridColumnReorderTest extends GridBasicClientFeaturesTest {
         assertColumnHeaderOrder(1, 2, 0, 3, 4);
     }
 
-    private void toggleColumnReorder() {
-        selectMenuPath("Component", "State", "Column Reordering");
-    }
-
     private void toggleSortableColumn(int index) {
         selectMenuPath("Component", "Columns", "Column " + index, "Sortable");
     }
diff --git a/uitest/src/com/vaadin/tests/widgetset/client/grid/GridBasicClientFeaturesWidget.java b/uitest/src/com/vaadin/tests/widgetset/client/grid/GridBasicClientFeaturesWidget.java
index 97f8e13ab1..6615cda8da 100644
--- a/uitest/src/com/vaadin/tests/widgetset/client/grid/GridBasicClientFeaturesWidget.java
+++ b/uitest/src/com/vaadin/tests/widgetset/client/grid/GridBasicClientFeaturesWidget.java
@@ -786,7 +786,12 @@ public class GridBasicClientFeaturesWidget extends
                     column.setHidden(!column.isHidden());
                 }
             }, "Component", "Columns", "Column " + i);
-
+            addMenuCommand("Hidable", new ScheduledCommand() {
+                @Override
+                public void execute() {
+                    column.setHidable(!column.isHidable());
+                }
+            }, "Component", "Columns", "Column " + i);
             addMenuCommand("auto", new ScheduledCommand() {
                 @Override
                 public void execute() {