From 41bf82e6dd57dc23c6cc298fde0a971305e9134b Mon Sep 17 00:00:00 2001
From: Teemu Suo-Anttila <teemusa@vaadin.com>
Date: Thu, 18 Dec 2014 13:22:11 +0200
Subject: Fix ClickableRenderers to use CellReferences (#13334)

This patch also uses row keys and column ids in communication rather
than indices.

Change-Id: Ie3bb554bd5c45700f1681160eef08bef8beeaaee
---
 server/src/com/vaadin/ui/Grid.java                 | 28 +++++++++++++++++++++-
 .../com/vaadin/ui/renderer/ClickableRenderer.java  | 24 ++++++++++++-------
 2 files changed, 43 insertions(+), 9 deletions(-)

(limited to 'server/src')

diff --git a/server/src/com/vaadin/ui/Grid.java b/server/src/com/vaadin/ui/Grid.java
index 60df269f10..8aee5ac19e 100644
--- a/server/src/com/vaadin/ui/Grid.java
+++ b/server/src/com/vaadin/ui/Grid.java
@@ -2382,9 +2382,35 @@ public class Grid extends AbstractComponent implements SelectionNotifier,
          * @return the item id corresponding to {@code key}
          */
         protected Object getItemId(String rowKey) {
+            return getParentGrid().getKeyMapper().getItemId(rowKey);
+        }
+
+        /**
+         * Gets the column for a column id.
+         * <p>
+         * An id is used to identify a particular column on both a server and a
+         * client. This method can be used to get the column for the column id
+         * that the client has sent.
+         * 
+         * @param columnId
+         *            the column id for which to retrieve a column
+         * @return the column corresponding to {@code columnId}
+         */
+        protected Column getColumn(String columnId) {
+            return getParentGrid().getColumnByColumnId(columnId);
+        }
+
+        /**
+         * Gets the parent Grid of the renderer.
+         * 
+         * @return parent grid
+         * @throws IllegalStateException
+         *             if parent is not Grid
+         */
+        protected Grid getParentGrid() {
             if (getParent() instanceof Grid) {
                 Grid grid = (Grid) getParent();
-                return grid.getKeyMapper().getItemId(rowKey);
+                return grid;
             } else {
                 throw new IllegalStateException(
                         "Renderers can be used only with Grid");
diff --git a/server/src/com/vaadin/ui/renderer/ClickableRenderer.java b/server/src/com/vaadin/ui/renderer/ClickableRenderer.java
index 0d745ab29e..ef293c7e3c 100644
--- a/server/src/com/vaadin/ui/renderer/ClickableRenderer.java
+++ b/server/src/com/vaadin/ui/renderer/ClickableRenderer.java
@@ -23,6 +23,7 @@ import com.vaadin.shared.MouseEventDetails;
 import com.vaadin.shared.ui.grid.renderers.RendererClickRpc;
 import com.vaadin.ui.Grid;
 import com.vaadin.ui.Grid.AbstractRenderer;
+import com.vaadin.ui.Grid.Column;
 import com.vaadin.util.ReflectTools;
 
 /**
@@ -64,11 +65,13 @@ public class ClickableRenderer<T> extends AbstractRenderer<T> {
     public static class RendererClickEvent extends ClickEvent {
 
         private Object itemId;
+        private Column column;
 
-        protected RendererClickEvent(Grid source, Object itemId,
+        protected RendererClickEvent(Grid source, Object itemId, Column column,
                 MouseEventDetails mouseEventDetails) {
             super(source, mouseEventDetails);
             this.itemId = itemId;
+            this.column = column;
         }
 
         /**
@@ -79,20 +82,25 @@ public class ClickableRenderer<T> extends AbstractRenderer<T> {
         public Object getItemId() {
             return itemId;
         }
+
+        /**
+         * Returns the {@link Column} where the click event originated.
+         * 
+         * @return the column of the click event
+         */
+        public Column getColumn() {
+            return column;
+        }
     }
 
     protected ClickableRenderer(Class<T> presentationType) {
         super(presentationType);
         registerRpc(new RendererClickRpc() {
             @Override
-            public void click(int row, int column,
+            public void click(String rowKey, String columnId,
                     MouseEventDetails mouseDetails) {
-
-                Grid grid = (Grid) getParent();
-                Object itemId = grid.getContainerDataSource().getIdByIndex(row);
-                // TODO map column index to property ID or send column ID
-                // instead of index from the client
-                fireEvent(new RendererClickEvent(grid, itemId, mouseDetails));
+                fireEvent(new RendererClickEvent(getParentGrid(),
+                        getItemId(rowKey), getColumn(columnId), mouseDetails));
             }
         });
     }
-- 
cgit v1.2.3