1 files changed, 166 insertions, 0 deletions
diff --git a/server/src/main/java/com/vaadin/ui/renderers/ClickableRenderer.java b/server/src/main/java/com/vaadin/ui/renderers/ClickableRenderer.java
new file mode 100644
index 0000000000..2617827b77
--- /dev/null
+++ b/server/src/main/java/com/vaadin/ui/renderers/ClickableRenderer.java
@@ -0,0 +1,166 @@
+/*
+ * Copyright 2000-2016 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.ui.renderers;
+
+import java.lang.reflect.Method;
+
+import com.vaadin.event.ConnectorEventListener;
+import com.vaadin.event.MouseEvents.ClickEvent;
+import com.vaadin.shared.MouseEventDetails;
+import com.vaadin.shared.ui.grid.renderers.RendererClickRpc;
+import com.vaadin.ui.Grid;
+import com.vaadin.ui.Grid.Column;
+import com.vaadin.util.ReflectTools;
+
+/**
+ * An abstract superclass for {@link Renderer}s that render clickable items.
+ * Click listeners can be added to a renderer to be notified when any of the
+ * rendered items is clicked.
+ *
+ * @param <T>
+ *            the type of the parent {@link Grid}
+ * @param <V>
+ *            the type presented by the renderer
+ *
+ * @since 7.4
+ * @author Vaadin Ltd
+ */
+public abstract class ClickableRenderer<T, V>
+        extends AbstractRenderer<T, V> {
+
+    /**
+     * An interface for listening to {@link RendererClickEvent renderer click
+     * events}.
+     *
+     * @see {@link ButtonRenderer#addClickListener(RendererClickListener)}
+     */
+    public interface RendererClickListener<T> extends ConnectorEventListener {
+
+        static final Method CLICK_METHOD = ReflectTools.findMethod(
+                RendererClickListener.class, "click", RendererClickEvent.class);
+
+        /**
+         * Called when a rendered button is clicked.
+         *
+         * @param event
+         *            the event representing the click
+         */
+        void click(RendererClickEvent<T> event);
+    }
+
+    /**
+     * An event fired when a clickable widget rendered by a ClickableRenderer is
+     * clicked.
+     *
+     * @param <T>
+     *            the item type associated with this click event
+     */
+    public static class RendererClickEvent<T> extends ClickEvent {
+
+        private T item;
+        private Column column;
+
+        protected RendererClickEvent(Grid<T> source, T item, Column column,
+                MouseEventDetails mouseEventDetails) {
+            super(source, mouseEventDetails);
+            this.item = item;
+            this.column = column;
+        }
+
+        /**
+         * Returns the item of the row where the click event originated.
+         *
+         * @return the item of the clicked row
+         */
+        public T getItem() {
+            return item;
+        }
+
+        /**
+         * Returns the {@link Column} where the click event originated.
+         *
+         * @return the column of the click event
+         */
+        public Column getColumn() {
+            return column;
+        }
+    }
+
+    /**
+     * Creates a new clickable renderer with the given presentation type. No
+     * null representation will be used.
+     *
+     * @param presentationType
+     *            the data type that this renderer displays, not
+     *            <code>null</code>
+     */
+    protected ClickableRenderer(Class<V> presentationType) {
+        this(presentationType, null);
+    }
+
+    /**
+     * Creates a new clickable renderer with the given presentation type and
+     * null representation.
+     *
+     * @param presentationType
+     *            the data type that this renderer displays, not
+     *            <code>null</code>
+     * @param nullRepresentation
+     *            a string that will be sent to the client instead of a regular
+     *            value in case the actual cell value is <code>null</code>. May
+     *            be <code>null</code>.
+     */
+    protected ClickableRenderer(Class<V> presentationType,
+            String nullRepresentation) {
+        super(presentationType, nullRepresentation);
+        registerRpc(new RendererClickRpc() {
+
+            @Override
+            public void click(String rowKey, String columnId,
+                    MouseEventDetails mouseDetails) {
+
+                Grid<T> grid = getParentGrid();
+                T item = grid.getDataCommunicator().getKeyMapper().get(rowKey);
+                Column column = grid.getColumn(columnId);
+
+                fireEvent(new RendererClickEvent<T>(grid, item, column,
+                        mouseDetails));
+            }
+        });
+    }
+
+    /**
+     * Adds a click listener to this button renderer. The listener is invoked
+     * every time one of the buttons rendered by this renderer is clicked.
+     *
+     * @param listener
+     *            the click listener to be added
+     */
+    public void addClickListener(RendererClickListener<T> listener) {
+        addListener(RendererClickEvent.class, listener,
+                RendererClickListener.CLICK_METHOD);
+    }
+
+    /**
+     * Removes the given click listener from this renderer.
+     *
+     * @param listener
+     *            the click listener to be removed
+     */
+    public void removeClickListener(RendererClickListener<T> listener) {
+        removeListener(RendererClickEvent.class, listener);
+    }
+}