Implement ContextClickEvent for Table (#19042)

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

Change-Id: I3aa88758278c91086df3d0971edb34914a93fd29

6 files changed, 423 insertions, 0 deletions

diff --git a/uitest/src/com/vaadin/tests/contextclick/AbstractContextClickTest.java b/uitest/src/com/vaadin/tests/contextclick/AbstractContextClickTest.java
new file mode 100644
index 0000000000..2323d0c9cb
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/contextclick/AbstractContextClickTest.java
@@ -0,0 +1,103 @@
+/*
+ * 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.contextclick;
+
+import static org.junit.Assert.assertEquals;
+
+import java.util.List;
+
+import org.junit.Test;
+import org.openqa.selenium.Point;
+import org.openqa.selenium.WebElement;
+import org.openqa.selenium.interactions.Actions;
+import org.openqa.selenium.remote.DesiredCapabilities;
+
+import com.vaadin.testbench.elements.AbstractComponentElement;
+import com.vaadin.testbench.elements.ButtonElement;
+import com.vaadin.testbench.parallel.BrowserUtil;
+import com.vaadin.tests.tb3.MultiBrowserTest;
+
+public abstract class AbstractContextClickTest extends MultiBrowserTest {
+
+    @Override
+    public List<DesiredCapabilities> getBrowsersToTest() {
+        return getBrowsersSupportingContextMenu();
+    }
+
+    @Test
+    public void testDefaultListener() {
+        openTestURL();
+
+        addOrRemoveDefaultListener();
+
+        assertDefaultContextClickListener(1);
+    }
+
+    protected void assertNoContextClickHandler() {
+        AbstractComponentElement component = $(AbstractComponentElement.class)
+                .id("testComponent");
+
+        String log = getLogRow(0);
+
+        contextClick(component);
+
+        assertEquals("Log entry without a context click listener.", log,
+                getLogRow(0));
+
+    }
+
+    protected void assertDefaultContextClickListener(int index) {
+        AbstractComponentElement component = $(AbstractComponentElement.class)
+                .id("testComponent");
+
+        contextClick(component);
+
+        Point l = component.getLocation();
+
+        int drift = 0;
+        // IE 10 and 11 report different Y location.
+        if (BrowserUtil.isIE(getDesiredCapabilities(), 10)
+                || BrowserUtil.isIE(getDesiredCapabilities(), 11)) {
+            drift = 1;
+        }
+
+        assertEquals(index + ". ContextClickEvent: (" + (l.getX() + 10) + ", "
+                + (l.getY() + 10 + drift) + ")", getLogRow(0));
+    }
+
+    protected void addOrRemoveDefaultListener() {
+        $(ButtonElement.class).caption("Add/Remove default listener").first()
+                .click();
+    }
+
+    protected void addOrRemoveTypedListener() {
+        $(ButtonElement.class).caption("Add/Remove typed listener").first()
+                .click();
+    }
+
+    /**
+     * Performs a context click followed by a regular click. This prevents
+     * browser context menu from blocking future operations.
+     * 
+     * @param e
+     *            web element
+     */
+    protected void contextClick(WebElement e) {
+        new Actions(getDriver()).moveToElement(e, 10, 10).contextClick()
+                .perform();
+        new Actions(getDriver()).moveToElement(e, 5, 5).click().perform();
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/contextclick/AbstractContextClickUI.java b/uitest/src/com/vaadin/tests/contextclick/AbstractContextClickUI.java
new file mode 100644
index 0000000000..9a0ef31692
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/contextclick/AbstractContextClickUI.java
@@ -0,0 +1,92 @@
+/*
+ * 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.contextclick;
+
+import com.vaadin.annotations.Theme;
+import com.vaadin.event.ContextClickEvent;
+import com.vaadin.event.ContextClickEvent.ContextClickListener;
+import com.vaadin.server.VaadinRequest;
+import com.vaadin.tests.components.AbstractTestUIWithLog;
+import com.vaadin.ui.AbstractComponent;
+import com.vaadin.ui.Button;
+import com.vaadin.ui.Button.ClickEvent;
+
+@Theme("valo")
+public abstract class AbstractContextClickUI<T extends AbstractComponent, E extends ContextClickEvent>
+        extends AbstractTestUIWithLog {
+
+    private final class ListenerHandler implements Button.ClickListener {
+        private boolean hasListener = false;
+        private final ContextClickListener listener;
+
+        public ListenerHandler(ContextClickListener listener) {
+            this.listener = listener;
+        }
+
+        @Override
+        public void buttonClick(ClickEvent event) {
+            if (!hasListener) {
+                testComponent.addContextClickListener(listener);
+                event.getButton().setDescription("Remove listener");
+                hasListener = true;
+            } else {
+                testComponent.removeContextClickListener(listener);
+                event.getButton().setDescription("Add listener");
+                hasListener = false;
+            }
+        }
+    }
+
+    protected T testComponent;
+    private ContextClickListener defaultListener = new ContextClickListener() {
+
+        @Override
+        public void contextClick(ContextClickEvent event) {
+            log("ContextClickEvent: (" + event.getClientX() + ", "
+                    + event.getClientY() + ")");
+        }
+    };
+
+    private ContextClickListener typedListener = new ContextClickListener() {
+
+        @Override
+        public void contextClick(ContextClickEvent event) {
+            try {
+                E typedEvent = (E) event;
+                handleContextClickEvent(typedEvent);
+            } catch (Exception e) {
+                log("UNEXPECTED EVENT TYPE!");
+            }
+        }
+    };
+
+    @Override
+    protected void setup(VaadinRequest request) {
+        testComponent = createTestComponent();
+        testComponent.setId("testComponent");
+
+        addComponent(testComponent);
+
+        addComponent(new Button("Add/Remove default listener",
+                new ListenerHandler(defaultListener)));
+        addComponent(new Button("Add/Remove typed listener",
+                new ListenerHandler(typedListener)));
+    }
+
+    protected abstract T createTestComponent();
+
+    protected abstract void handleContextClickEvent(E event);
+}
diff --git a/uitest/src/com/vaadin/tests/contextclick/ListenerAddAndRemoveTest.java b/uitest/src/com/vaadin/tests/contextclick/ListenerAddAndRemoveTest.java
new file mode 100644
index 0000000000..01fbd87d74
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/contextclick/ListenerAddAndRemoveTest.java
@@ -0,0 +1,58 @@
+/*
+ * 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.contextclick;
+
+import org.junit.Test;
+
+public class ListenerAddAndRemoveTest extends TableContextClickTestBase {
+
+    @Test
+    public void testAddAndRemoveListeners() {
+        openTestURL();
+
+        // Add typed listener
+        addOrRemoveTypedListener();
+
+        // Add default listener
+        addOrRemoveDefaultListener();
+
+        // Remove the default listener
+        addOrRemoveDefaultListener();
+
+        // Check that typed listener is still working
+        assertTypedContextClickListener(1);
+
+        // Re-add the default listener
+        addOrRemoveDefaultListener();
+
+        // Remove typed listener
+        addOrRemoveTypedListener();
+
+        // Check that default listener still works
+        assertDefaultContextClickListener(3);
+
+        // Remove default listener
+        addOrRemoveDefaultListener();
+
+        // Assert no listeners present.
+        assertNoContextClickHandler();
+
+        // Re-add typed listener
+        addOrRemoveTypedListener();
+
+        assertTypedContextClickListener(4);
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/contextclick/TableContextClick.java b/uitest/src/com/vaadin/tests/contextclick/TableContextClick.java
new file mode 100644
index 0000000000..8d75dd61c0
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/contextclick/TableContextClick.java
@@ -0,0 +1,52 @@
+/*
+ * 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.contextclick;
+
+import com.vaadin.data.Item;
+import com.vaadin.shared.ui.table.TableConstants.Section;
+import com.vaadin.tests.util.PersonContainer;
+import com.vaadin.ui.Table;
+import com.vaadin.ui.Table.TableContextClickEvent;
+
+public class TableContextClick extends
+        AbstractContextClickUI<Table, TableContextClickEvent> {
+
+    @Override
+    protected Table createTestComponent() {
+        Table table = new Table();
+        table.setContainerDataSource(PersonContainer.createWithTestData());
+        table.setFooterVisible(true);
+        return table;
+    }
+
+    @Override
+    protected void handleContextClickEvent(TableContextClickEvent event) {
+        String value = "";
+        Object propertyId = event.getPropertyId();
+        if (event.getItemId() != null) {
+            Item item = event.getComponent().getContainerDataSource()
+                    .getItem(event.getItemId());
+            value += item.getItemProperty("firstName").getValue() + " ";
+            value += item.getItemProperty("lastName").getValue();
+        } else if (event.getSection() == Section.HEADER) {
+            value = testComponent.getColumnHeader(propertyId);
+        } else if (event.getSection() == Section.FOOTER) {
+            value = testComponent.getColumnFooter(propertyId);
+        }
+        log("ContextClickEvent value: " + value + ", propertyId: " + propertyId
+                + ", section: " + event.getSection());
+    }
+}
diff --git a/uitest/src/com/vaadin/tests/contextclick/TableContextClickTest.java b/uitest/src/com/vaadin/tests/contextclick/TableContextClickTest.java
new file mode 100644
index 0000000000..51efbf9498
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/contextclick/TableContextClickTest.java
@@ -0,0 +1,73 @@
+/*
+ * 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.contextclick;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+
+import com.vaadin.testbench.elements.TableElement;
+
+public class TableContextClickTest extends TableContextClickTestBase {
+
+    @Test
+    public void testBodyContextClickWithTypedListener() {
+        openTestURL();
+
+        addOrRemoveTypedListener();
+
+        assertTypedContextClickListener(1);
+    }
+
+    @Test
+    public void testHeaderContextClickWithTypedListener() {
+        openTestURL();
+
+        addOrRemoveTypedListener();
+
+        contextClick($(TableElement.class).first().getHeaderCell(0));
+
+        assertEquals(
+                "1. ContextClickEvent value: address, propertyId: address, section: HEADER",
+                getLogRow(0));
+
+        contextClick($(TableElement.class).first().getHeaderCell(3));
+
+        assertEquals(
+                "2. ContextClickEvent value: lastName, propertyId: lastName, section: HEADER",
+                getLogRow(0));
+    }
+
+    @Test
+    public void testFooterContextClickWithTypedListener() {
+        openTestURL();
+
+        addOrRemoveTypedListener();
+
+        contextClick($(TableElement.class).first().getFooterCell(0));
+
+        assertEquals(
+                "1. ContextClickEvent value: null, propertyId: address, section: FOOTER",
+                getLogRow(0));
+
+        contextClick($(TableElement.class).first().getFooterCell(3));
+
+        assertEquals(
+                "2. ContextClickEvent value: null, propertyId: lastName, section: FOOTER",
+                getLogRow(0));
+    }
+
+}
diff --git a/uitest/src/com/vaadin/tests/contextclick/TableContextClickTestBase.java b/uitest/src/com/vaadin/tests/contextclick/TableContextClickTestBase.java
new file mode 100644
index 0000000000..e3f4647c33
--- /dev/null
+++ b/uitest/src/com/vaadin/tests/contextclick/TableContextClickTestBase.java
@@ -0,0 +1,45 @@
+/*
+ * 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.contextclick;
+
+import static org.junit.Assert.assertEquals;
+
+import com.vaadin.testbench.elements.TableElement;
+
+public abstract class TableContextClickTestBase extends
+        AbstractContextClickTest {
+
+    @Override
+    protected Class<?> getUIClass() {
+        return TableContextClick.class;
+    }
+
+    protected void assertTypedContextClickListener(int startIndex) {
+        contextClick($(TableElement.class).first().getCell(0, 0));
+
+        assertEquals(
+                (startIndex++)
+                        + ". ContextClickEvent value: Lisa Schneider, propertyId: address, section: BODY",
+                getLogRow(0));
+
+        contextClick($(TableElement.class).first().getCell(0, 3));
+
+        assertEquals(
+                startIndex
+                        + ". ContextClickEvent value: Lisa Schneider, propertyId: lastName, section: BODY",
+                getLogRow(0));
+    }
+}