Add support for ContextClickEvent in AbstractComponent (#19015)

Change-Id: I93d5d20925b8ac9b4b108ccc6deec2090e68aa0d

1 files changed, 82 insertions, 0 deletions

diff --git a/server/src/com/vaadin/event/ContextClickEvent.java b/server/src/com/vaadin/event/ContextClickEvent.java
new file mode 100644
index 0000000000..88b46d938b
--- /dev/null
+++ b/server/src/com/vaadin/event/ContextClickEvent.java
@@ -0,0 +1,82 @@
+/*
+ * 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.event;
+
+import java.io.Serializable;
+import java.lang.reflect.Method;
+
+import com.vaadin.event.MouseEvents.ClickEvent;
+import com.vaadin.shared.MouseEventDetails;
+import com.vaadin.ui.Component;
+import com.vaadin.util.ReflectTools;
+
+/**
+ * Context click event fired by a {@link Component}. ContextClickEvent happens
+ * when context click happens on the client-side inside the Component.
+ * 
+ * @since
+ * @author Vaadin Ltd
+ */
+public class ContextClickEvent extends ClickEvent {
+
+    public static final Method CONTEXT_CLICK_METHOD = ReflectTools
+            .findMethod(ContextClickListener.class, "contextClick",
+                    ContextClickEvent.class);
+
+    public ContextClickEvent(Component source,
+            MouseEventDetails mouseEventDetails) {
+        super(source, mouseEventDetails);
+    }
+
+    /**
+     * Listener for {@link ContextClickEvent ContextClickEvents}.
+     */
+    public interface ContextClickListener extends Serializable {
+
+        /**
+         * Called when the context click happens.
+         * 
+         * @param event
+         *            the context click event
+         */
+        public void contextClick(ContextClickEvent event);
+    }
+
+    /**
+     * The interface for adding and removing listeners for
+     * {@link ContextClickEvent ContextClickEvents}.
+     */
+    public interface ContextClickNotifier extends Serializable {
+        /**
+         * Adds a context click listener that gets notified when a context click
+         * happens.
+         * 
+         * @param listener
+         *            the context click listener to add
+         */
+        public void addContextClickListener(ContextClickListener listener);
+
+        /**
+         * Removes a context click listener that was previously added with
+         * {@link #addContextClickListener(ContextClickListener)}.
+         * 
+         * @param listener
+         *            the context click listener to remove
+         */
+        public void removeContextClickListener(ContextClickListener listener);
+    }
+
+}