com.vaadin.ui.renderers.ClickableRenderer Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* 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.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.AbstractRenderer;
import com.vaadin.ui.Grid.Column;
import com.vaadin.util.ReflectTools;
/**
* An abstract superclass for Renderers that render clickable items. Click
* listeners can be added to a renderer to be notified when any of the rendered
* items is clicked.
*
* @param
* the type presented by the renderer
*
* @since 7.4
* @author Vaadin Ltd
*/
public class ClickableRenderer extends AbstractRenderer {
/**
* An interface for listening to {@link RendererClickEvent renderer click
* events}.
*
* @see ButtonRenderer#addClickListener(RendererClickListener)
*/
public interface RendererClickListener 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 event);
}
/**
* An event fired when a button rendered by a ButtonRenderer is clicked.
*/
public static class RendererClickEvent extends ClickEvent {
private Object itemId;
private Column column;
protected RendererClickEvent(Grid source, Object itemId, Column column,
MouseEventDetails mouseEventDetails) {
super(source, mouseEventDetails);
this.itemId = itemId;
this.column = column;
}
/**
* Returns the item ID of the row where the click event originated.
*
* @return the item ID of the clicked row
*/
public Object getItemId() {
return itemId;
}
/**
* Returns the {@link Column} where the click event originated.
*
* @return the column of the click event
*/
public Column getColumn() {
return column;
}
/**
* Returns the property ID where the click event originated.
*
* @return the property ID of the clicked cell
*/
public Object getPropertyId() {
return column.getPropertyId();
}
}
protected ClickableRenderer(Class presentationType) {
this(presentationType, null);
}
protected ClickableRenderer(Class presentationType,
String nullRepresentation) {
super(presentationType, nullRepresentation);
registerRpc(new RendererClickRpc() {
@Override
public void click(String rowKey, String columnId,
MouseEventDetails mouseDetails) {
fireEvent(new RendererClickEvent(getParentGrid(),
getItemId(rowKey), getColumn(columnId), 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 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 listener) {
removeListener(RendererClickEvent.class, listener);
}
}