com.vaadin.event.ContextClickEvent Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* 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.shared.Registration;
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 7.6
* @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}.
*/
@FunctionalInterface
public interface ContextClickListener extends SerializableEventListener {
/**
* 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.
*
* @see Registration
*
* @param listener
* the context click listener to add, not null
* @return a registration object for removing the listener
* @since 8.0
*/
public Registration addContextClickListener(
ContextClickListener listener);
/**
* Removes a context click listener that was previously added with
* {@link #addContextClickListener(ContextClickListener)}.
*
* @param listener
* the context click listener to remove
*
* @deprecated As of 8.0, replaced by {@link Registration#remove()} in
* the registration object returned from
* {@link #addContextClickListener(ContextClickListener)} .
*/
@Deprecated
public void removeContextClickListener(ContextClickListener listener);
}
}