Update Select all -CheckBox from server and partial selections (#17590)

Change-Id: I8f4986455029fc3b997ec5fee8916fa118a487ca

6 files changed, 155 insertions, 32 deletions

diff --git a/client/src/com/vaadin/client/connectors/GridConnector.java b/client/src/com/vaadin/client/connectors/GridConnector.java
index a99b227abe..15acbc0d5a 100644
--- a/client/src/com/vaadin/client/connectors/GridConnector.java
+++ b/client/src/com/vaadin/client/connectors/GridConnector.java
@@ -33,6 +33,7 @@ import com.google.gwt.core.client.Scheduler;
 import com.google.gwt.core.client.Scheduler.ScheduledCommand;
 import com.google.gwt.dom.client.NativeEvent;
 import com.google.gwt.user.client.Timer;
+import com.google.gwt.user.client.ui.CheckBox;
 import com.google.gwt.user.client.ui.Widget;
 import com.vaadin.client.ComponentConnector;
 import com.vaadin.client.ConnectorHierarchyChangeEvent;
@@ -681,6 +682,26 @@ public class GridConnector extends AbstractHasComponentsConnector implements
             public void recalculateColumnWidths() {
                 getWidget().recalculateColumnWidths();
             }
+
+            @Override
+            public void setSelectAll(boolean allSelected) {
+                if (selectionModel instanceof SelectionModel.Multi
+                        && selectionModel.getSelectionColumnRenderer() != null) {
+                    final Widget widget;
+                    try {
+                        HeaderRow defaultHeaderRow = getWidget()
+                                .getDefaultHeaderRow();
+                        if (defaultHeaderRow != null) {
+                            widget = defaultHeaderRow.getCell(
+                                    getWidget().getColumn(0)).getWidget();
+                            ((CheckBox) widget).setValue(allSelected, false);
+                        }
+                    } catch (Exception e) {
+                        getLogger().warning(
+                                "Problems finding select all checkbox.");
+                    }
+                }
+            }
         });
 
         getWidget().addSelectionHandler(internalSelectionChangeHandler);
diff --git a/client/src/com/vaadin/client/widgets/Grid.java b/client/src/com/vaadin/client/widgets/Grid.java
index 377943ed61..8db6e9a55a 100644
--- a/client/src/com/vaadin/client/widgets/Grid.java
+++ b/client/src/com/vaadin/client/widgets/Grid.java
@@ -2377,6 +2377,7 @@ public class Grid<T> extends ResizeComposite implements
 
         private boolean initDone = false;
         private boolean selected = false;
+        private CheckBox selectAllCheckBox;
 
         SelectionColumn(final Renderer<Boolean> selectColumnRenderer) {
             super(selectColumnRenderer);
@@ -2401,41 +2402,55 @@ public class Grid<T> extends ResizeComposite implements
              * exist.
              */
             final SelectionModel.Multi<T> model = (Multi<T>) getSelectionModel();
-            final CheckBox checkBox = GWT.create(CheckBox.class);
-            checkBox.addValueChangeHandler(new ValueChangeHandler<Boolean>() {
 
-                @Override
-                public void onValueChange(ValueChangeEvent<Boolean> event) {
-                    if (event.getValue()) {
-                        fireEvent(new SelectAllEvent<T>(model));
-                        selected = true;
-                    } else {
-                        model.deselectAll();
-                        selected = false;
-                    }
-                }
-            });
-            checkBox.setValue(selected);
-            selectionCell.setWidget(checkBox);
-            // Select all with space when "select all" cell is active
-            addHeaderKeyUpHandler(new HeaderKeyUpHandler() {
-                @Override
-                public void onKeyUp(GridKeyUpEvent event) {
-                    if (event.getNativeKeyCode() != KeyCodes.KEY_SPACE) {
-                        return;
-                    }
-                    HeaderRow targetHeaderRow = getHeader().getRow(
-                            event.getFocusedCell().getRowIndex());
-                    if (!targetHeaderRow.isDefault()) {
-                        return;
+            if (selectAllCheckBox == null) {
+                selectAllCheckBox = GWT.create(CheckBox.class);
+                selectAllCheckBox
+                        .addValueChangeHandler(new ValueChangeHandler<Boolean>() {
+
+                            @Override
+                            public void onValueChange(
+                                    ValueChangeEvent<Boolean> event) {
+                                if (event.getValue()) {
+                                    fireEvent(new SelectAllEvent<T>(model));
+                                    selected = true;
+                                } else {
+                                    model.deselectAll();
+                                    selected = false;
+                                }
+                            }
+                        });
+                selectAllCheckBox.setValue(selected);
+
+                // Select all with space when "select all" cell is active
+                addHeaderKeyUpHandler(new HeaderKeyUpHandler() {
+                    @Override
+                    public void onKeyUp(GridKeyUpEvent event) {
+                        if (event.getNativeKeyCode() != KeyCodes.KEY_SPACE) {
+                            return;
+                        }
+                        HeaderRow targetHeaderRow = getHeader().getRow(
+                                event.getFocusedCell().getRowIndex());
+                        if (!targetHeaderRow.isDefault()) {
+                            return;
+                        }
+                        if (event.getFocusedCell().getColumn() == SelectionColumn.this) {
+                            // Send events to ensure state is updated
+                            selectAllCheckBox.setValue(
+                                    !selectAllCheckBox.getValue(), true);
+                        }
                     }
-                    if (event.getFocusedCell().getColumn() == SelectionColumn.this) {
-                        // Send events to ensure row selection state is
-                        // updated
-                        checkBox.setValue(!checkBox.getValue(), true);
+                });
+            } else {
+                for (HeaderRow row : header.getRows()) {
+                    if (row.getCell(this).getType() == GridStaticCellType.WIDGET) {
+                        // Detach from old header.
+                        row.getCell(this).setText("");
                     }
                 }
-            });
+            }
+
+            selectionCell.setWidget(selectAllCheckBox);
         }
 
         @Override
@@ -2497,7 +2512,6 @@ public class Grid<T> extends ResizeComposite implements
             super.setEditable(editable);
             return this;
         }
-
     }
 
     /**
diff --git a/server/src/com/vaadin/ui/Grid.java b/server/src/com/vaadin/ui/Grid.java
index ea973bb3ba..3e4a78db9d 100644
--- a/server/src/com/vaadin/ui/Grid.java
+++ b/server/src/com/vaadin/ui/Grid.java
@@ -1068,6 +1068,8 @@ public class Grid extends AbstractComponent implements SelectionNotifier,
 
         private int selectionLimit = DEFAULT_MAX_SELECTIONS;
 
+        private boolean allSelected;
+
         @Override
         public boolean select(final Object... itemIds)
                 throws IllegalArgumentException {
@@ -1113,6 +1115,9 @@ public class Grid extends AbstractComponent implements SelectionNotifier,
                 }
                 fireSelectionEvent(oldSelection, selection);
             }
+
+            updateAllSelectedState();
+
             return selectionWillChange;
         }
 
@@ -1178,6 +1183,9 @@ public class Grid extends AbstractComponent implements SelectionNotifier,
                 selection.removeAll(itemIds);
                 fireSelectionEvent(oldSelection, selection);
             }
+
+            updateAllSelectedState();
+
             return hasCommonElements;
         }
 
@@ -1258,6 +1266,8 @@ public class Grid extends AbstractComponent implements SelectionNotifier,
                 fireSelectionEvent(oldSelection, selection);
             }
 
+            updateAllSelectedState();
+
             return changed;
         }
 
@@ -1271,6 +1281,13 @@ public class Grid extends AbstractComponent implements SelectionNotifier,
                         "Vararg array of itemIds may not be null");
             }
         }
+
+        private void updateAllSelectedState() {
+            if (allSelected != selection.size() >= selectionLimit) {
+                allSelected = selection.size() >= selectionLimit;
+                grid.getRpcProxy(GridClientRpc.class).setSelectAll(allSelected);
+            }
+        }
     }
 
     /**
diff --git a/shared/src/com/vaadin/shared/ui/grid/GridClientRpc.java b/shared/src/com/vaadin/shared/ui/grid/GridClientRpc.java
index ac1b1d5a78..cf4e95d078 100644
--- a/shared/src/com/vaadin/shared/ui/grid/GridClientRpc.java
+++ b/shared/src/com/vaadin/shared/ui/grid/GridClientRpc.java
@@ -55,4 +55,15 @@ public interface GridClientRpc extends ClientRpc {
      * Command client Grid to recalculate column widths.
      */
     public void recalculateColumnWidths();
+
+    /**
+     * Informs the Grid that all items have been selected or not selected on the
+     * server side.
+     * 
+     * @since
+     * @param allSelected
+     *            <code>true</code> to check the select all checkbox,
+     *            <code>false</code> to uncheck it.
+     */
+    public void setSelectAll(boolean allSelected);
 }
diff --git a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicFeatures.java b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicFeatures.java
index ef51cdf446..6511866897 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicFeatures.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridBasicFeatures.java
@@ -683,6 +683,26 @@ public class GridBasicFeatures extends AbstractComponentTest<Grid> {
                         c.setColumnReorderingAllowed(value);
                     }
                 });
+
+        createClickAction("Select all", "State", new Command<Grid, String>() {
+            @Override
+            public void execute(Grid c, String value, Object data) {
+                SelectionModel selectionModel = c.getSelectionModel();
+                if (selectionModel instanceof SelectionModel.Multi) {
+                    ((SelectionModel.Multi) selectionModel).selectAll();
+                }
+            }
+        }, null);
+
+        createClickAction("Select none", "State", new Command<Grid, String>() {
+            @Override
+            public void execute(Grid c, String value, Object data) {
+                SelectionModel selectionModel = c.getSelectionModel();
+                if (selectionModel instanceof SelectionModel.Multi) {
+                    ((SelectionModel.Multi) selectionModel).deselectAll();
+                }
+            }
+        }, null);
     }
 
     protected void createHeaderActions() {
diff --git a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/server/GridSelectionTest.java b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/server/GridSelectionTest.java
index 9953bbcae0..1f3085d273 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/server/GridSelectionTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/server/GridSelectionTest.java
@@ -20,8 +20,10 @@ import static org.junit.Assert.assertTrue;
 
 import org.junit.Test;
 import org.openqa.selenium.Keys;
+import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.interactions.Actions;
+import org.openqa.selenium.support.ui.ExpectedCondition;
 
 import com.vaadin.testbench.By;
 import com.vaadin.testbench.elements.GridElement;
@@ -335,6 +337,44 @@ public class GridSelectionTest extends GridBasicFeaturesTest {
                 getRow(5).isSelected());
     }
 
+    @Test
+    public void testServerSideSelectTogglesSelectAllCheckBox() {
+        openTestURL();
+
+        setSelectionModelMulti();
+        GridCellElement header = getGridElement().getHeaderCell(0, 0);
+
+        WebElement selectAll = header.findElement(By.tagName("input"));
+
+        selectMenuPath("Component", "State", "Select all");
+        waitUntilCheckBoxValue(selectAll, true);
+        assertTrue("Select all CheckBox wasn't selected as expected",
+                selectAll.isSelected());
+
+        selectMenuPath("Component", "State", "Select none");
+        waitUntilCheckBoxValue(selectAll, false);
+        assertFalse("Select all CheckBox was selected unexpectedly",
+                selectAll.isSelected());
+
+        selectMenuPath("Component", "State", "Select all");
+        waitUntilCheckBoxValue(selectAll, true);
+        getGridElement().getCell(5, 0).click();
+        waitUntilCheckBoxValue(selectAll, false);
+        assertFalse("Select all CheckBox was selected unexpectedly",
+                selectAll.isSelected());
+    }
+
+    private void waitUntilCheckBoxValue(final WebElement checkBoxElememnt,
+            final boolean expectedValue) {
+        waitUntil(new ExpectedCondition<Boolean>() {
+            @Override
+            public Boolean apply(WebDriver input) {
+                return expectedValue ? checkBoxElememnt.isSelected()
+                        : !checkBoxElememnt.isSelected();
+            }
+        }, 5);
+    }
+
     private void setSelectionModelMulti() {
         selectMenuPath("Component", "State", "Selection mode", "multi");
     }