From 5616216306a138b3437d188e4b2df8253590abf5 Mon Sep 17 00:00:00 2001
From: Denis <denis@vaadin.com>
Date: Fri, 27 Jan 2017 13:13:58 +0200
Subject: Allow to disable user selection in the grid model. (#8345)

* Allow to disable user selection in the grid model.

Fixes vaadin/framework8-issues#546
---
 .../ui/components/grid/AbstractSelectionModel.java | 10 ++++++++++
 .../ui/components/grid/GridSelectionModel.java     | 23 ++++++++++++++++++++++
 .../components/grid/MultiSelectionModelImpl.java   |  6 +-----
 .../ui/components/grid/NoSelectionModel.java       |  9 +++++++++
 .../components/grid/SingleSelectionModelImpl.java  |  7 +------
 5 files changed, 44 insertions(+), 11 deletions(-)

(limited to 'server')

diff --git a/server/src/main/java/com/vaadin/ui/components/grid/AbstractSelectionModel.java b/server/src/main/java/com/vaadin/ui/components/grid/AbstractSelectionModel.java
index e38c350694..7a47da0ce1 100644
--- a/server/src/main/java/com/vaadin/ui/components/grid/AbstractSelectionModel.java
+++ b/server/src/main/java/com/vaadin/ui/components/grid/AbstractSelectionModel.java
@@ -99,4 +99,14 @@ public abstract class AbstractSelectionModel<T> extends AbstractGridExtension<T>
         super.remove();
     }
 
+    @Override
+    public boolean isUserSelectionAllowed() {
+        return getState(false).selectionAllowed;
+    }
+
+    @Override
+    public void setUserSelectionAllowed(boolean allowed) {
+        getState().selectionAllowed = allowed;
+    }
+
 }
diff --git a/server/src/main/java/com/vaadin/ui/components/grid/GridSelectionModel.java b/server/src/main/java/com/vaadin/ui/components/grid/GridSelectionModel.java
index 2913318bf8..4160b5951b 100644
--- a/server/src/main/java/com/vaadin/ui/components/grid/GridSelectionModel.java
+++ b/server/src/main/java/com/vaadin/ui/components/grid/GridSelectionModel.java
@@ -43,4 +43,27 @@ public interface GridSelectionModel<T> extends SelectionModel<T>, Extension {
      */
     @Override
     public void remove();
+
+    /**
+     * Sets whether the user is allowed to change the selection.
+     * <p>
+     * The check is done only for the client side actions. It doesn't affect
+     * selection requests sent from the server side.
+     *
+     * @param allowed
+     *            <code>true</code> if the user is allowed to change the
+     *            selection, <code>false</code> otherwise
+     */
+    public void setUserSelectionAllowed(boolean allowed);
+
+    /**
+     * Checks if the user is allowed to change the selection.
+     * <p>
+     * The check is done only for the client side actions. It doesn't affect
+     * selection requests sent from the server side.
+     *
+     * @return <code>true</code> if the user is allowed to change the selection,
+     *         <code>false</code> otherwise
+     */
+    public boolean isUserSelectionAllowed();
 }
diff --git a/server/src/main/java/com/vaadin/ui/components/grid/MultiSelectionModelImpl.java b/server/src/main/java/com/vaadin/ui/components/grid/MultiSelectionModelImpl.java
index 97f79a4655..122abadc5a 100644
--- a/server/src/main/java/com/vaadin/ui/components/grid/MultiSelectionModelImpl.java
+++ b/server/src/main/java/com/vaadin/ui/components/grid/MultiSelectionModelImpl.java
@@ -324,7 +324,7 @@ public class MultiSelectionModelImpl<T> extends AbstractSelectionModel<T>
 
             @Override
             public void setReadOnly(boolean readOnly) {
-                getState().selectionAllowed = !readOnly;
+                setUserSelectionAllowed(!readOnly);
             }
 
             @Override
@@ -458,10 +458,6 @@ public class MultiSelectionModelImpl<T> extends AbstractSelectionModel<T>
         }, userOriginated);
     }
 
-    private boolean isUserSelectionAllowed() {
-        return getState(false).selectionAllowed;
-    }
-
     private void doUpdateSelection(Consumer<Collection<T>> handler,
             boolean userOriginated) {
         if (getParent() == null) {
diff --git a/server/src/main/java/com/vaadin/ui/components/grid/NoSelectionModel.java b/server/src/main/java/com/vaadin/ui/components/grid/NoSelectionModel.java
index ff51b74cfc..b239469e79 100644
--- a/server/src/main/java/com/vaadin/ui/components/grid/NoSelectionModel.java
+++ b/server/src/main/java/com/vaadin/ui/components/grid/NoSelectionModel.java
@@ -64,4 +64,13 @@ public class NoSelectionModel<T> extends AbstractExtension
                 "This selection model doesn't allow selection, cannot add selection listeners to it");
     }
 
+    @Override
+    public void setUserSelectionAllowed(boolean allowed) {
+    }
+
+    @Override
+    public boolean isUserSelectionAllowed() {
+        return false;
+    }
+
 }
diff --git a/server/src/main/java/com/vaadin/ui/components/grid/SingleSelectionModelImpl.java b/server/src/main/java/com/vaadin/ui/components/grid/SingleSelectionModelImpl.java
index 12f3ee4de4..aae0da8e14 100644
--- a/server/src/main/java/com/vaadin/ui/components/grid/SingleSelectionModelImpl.java
+++ b/server/src/main/java/com/vaadin/ui/components/grid/SingleSelectionModelImpl.java
@@ -27,7 +27,6 @@ import com.vaadin.event.selection.SingleSelectionListener;
 import com.vaadin.shared.Registration;
 import com.vaadin.shared.data.selection.SelectionServerRpc;
 import com.vaadin.shared.ui.grid.SingleSelectionModelState;
-import com.vaadin.ui.Component;
 import com.vaadin.ui.SingleSelect;
 
 /**
@@ -227,10 +226,6 @@ public class SingleSelectionModelImpl<T> extends AbstractSelectionModel<T>
         return getState().deselectAllowed;
     }
 
-    private boolean isUserSelectionAllowed() {
-        return getState(false).selectionAllowed;
-    }
-
     /**
      * Gets a wrapper for using this grid as a single select in a binder.
      *
@@ -275,7 +270,7 @@ public class SingleSelectionModelImpl<T> extends AbstractSelectionModel<T>
 
             @Override
             public void setReadOnly(boolean readOnly) {
-                getState().selectionAllowed = !readOnly;
+                setUserSelectionAllowed(!readOnly);
             }
 
             @Override
-- 
cgit v1.2.3