Implement ContextClickEvent for Table (#19042)

This patch also introduces a testing infrastructure for context click
event and listener testing.

Change-Id: I3aa88758278c91086df3d0971edb34914a93fd29

2 files changed, 123 insertions, 0 deletions

diff --git a/server/src/com/vaadin/ui/Table.java b/server/src/com/vaadin/ui/Table.java
index 5f22ec46ab..f7b0853ce9 100644
--- a/server/src/com/vaadin/ui/Table.java
+++ b/server/src/com/vaadin/ui/Table.java
@@ -46,6 +46,7 @@ import com.vaadin.data.util.converter.Converter;
 import com.vaadin.data.util.converter.ConverterUtil;
 import com.vaadin.event.Action;
 import com.vaadin.event.Action.Handler;
+import com.vaadin.event.ContextClickEvent;
 import com.vaadin.event.DataBoundTransferable;
 import com.vaadin.event.ItemClickEvent;
 import com.vaadin.event.ItemClickEvent.ItemClickListener;
@@ -65,6 +66,8 @@ import com.vaadin.server.Resource;
 import com.vaadin.shared.MouseEventDetails;
 import com.vaadin.shared.ui.MultiSelectMode;
 import com.vaadin.shared.ui.table.TableConstants;
+import com.vaadin.shared.ui.table.TableConstants.Section;
+import com.vaadin.shared.ui.table.TableServerRpc;
 import com.vaadin.shared.util.SharedUtil;
 import com.vaadin.ui.declarative.DesignAttributeHandler;
 import com.vaadin.ui.declarative.DesignContext;
@@ -595,6 +598,18 @@ public class Table extends AbstractSelect implements Action.Container,
      */
     public Table() {
         setRowHeaderMode(ROW_HEADER_MODE_HIDDEN);
+
+        registerRpc(new TableServerRpc() {
+
+            @Override
+            public void contextClick(String rowKey, String colKey,
+                    Section section, MouseEventDetails details) {
+                Object itemId = itemIdMapper.get(rowKey);
+                Object propertyId = columnIdMap.get(colKey);
+                fireEvent(new TableContextClickEvent(Table.this, details,
+                        itemId, propertyId, section));
+            }
+        });
     }
 
     /**
@@ -6377,6 +6392,57 @@ public class Table extends AbstractSelect implements Action.Container,
         return result;
     }
 
+    /* Context Click handling */
+
+    public static class TableContextClickEvent extends ContextClickEvent {
+
+        private final Object itemId;
+        private final Object propertyId;
+        private final Section section;
+
+        public TableContextClickEvent(Table source,
+                MouseEventDetails mouseEventDetails, Object itemId,
+                Object propertyId, Section section) {
+            super(source, mouseEventDetails);
+
+            this.itemId = itemId;
+            this.propertyId = propertyId;
+            this.section = section;
+        }
+
+        /**
+         * Returns the item id of context clicked row.
+         * 
+         * @return item id of clicked row; <code>null</code> if header or footer
+         */
+        public Object getItemId() {
+            return itemId;
+        }
+
+        /**
+         * Returns the property id of context clicked column.
+         * 
+         * @return property id
+         */
+        public Object getPropertyId() {
+            return propertyId;
+        }
+
+        /**
+         * Returns the clicked section of Table.
+         * 
+         * @return section of Table
+         */
+        public Section getSection() {
+            return section;
+        }
+
+        @Override
+        public Table getComponent() {
+            return (Table) super.getComponent();
+        }
+    }
+
     private final Logger getLogger() {
         if (logger == null) {
             logger = Logger.getLogger(Table.class.getName());
diff --git a/server/tests/src/com/vaadin/tests/server/component/table/TableContextClickTest.java b/server/tests/src/com/vaadin/tests/server/component/table/TableContextClickTest.java
new file mode 100644
index 0000000000..d96a5d626a
--- /dev/null
+++ b/server/tests/src/com/vaadin/tests/server/component/table/TableContextClickTest.java
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2000-2014 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.tests.server.component.table;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import com.vaadin.event.ContextClickEvent;
+import com.vaadin.event.ContextClickEvent.ContextClickListener;
+import com.vaadin.shared.ui.table.TableConstants.Section;
+import com.vaadin.ui.Table;
+
+public class TableContextClickTest extends Table {
+
+    private String error = null;
+    private boolean handled = false;
+
+    @Test
+    public void testContextClickListenerWithTableEvent() {
+        addContextClickListener(new ContextClickListener() {
+
+            @Override
+            public void contextClick(ContextClickEvent event) {
+                if (!(event instanceof TableContextClickEvent)) {
+                    return;
+                }
+
+                TableContextClickEvent e = (TableContextClickEvent) event;
+                if (e.getSection() != Section.BODY) {
+                    error = "Event section was not BODY.";
+                }
+                handled = true;
+            }
+        });
+        fireEvent(new TableContextClickEvent(this, null, null, null,
+                Section.BODY));
+
+        if (error != null) {
+            Assert.fail(error);
+        } else if (!handled) {
+            Assert.fail("Event was not handled by the ContextClickListener");
+        }
+    }
+}