com.vaadin.ui.renderers.ClickableRenderer 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.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.Registration;
import com.vaadin.shared.ui.grid.renderers.ClickableRendererState;
import com.vaadin.shared.ui.grid.renderers.RendererClickRpc;
import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.Column;
import com.vaadin.util.ReflectTools;
/**
* An abstract superclass for {@link Renderer}s 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 of the parent {@link Grid}
* @param
* the type presented by the renderer
*
* @since 7.4
* @author Vaadin Ltd
*/
public abstract class ClickableRenderer extends AbstractRenderer {
/**
* An interface for listening to {@link RendererClickEvent renderer click
* events}.
*
* @see ButtonRenderer#addClickListener(RendererClickListener)
*/
@FunctionalInterface
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 clickable widget rendered by a ClickableRenderer is
* clicked.
*
* @param
* the item type associated with this click event
*/
public static class RendererClickEvent extends ClickEvent {
private final T item;
private final Column column;
protected RendererClickEvent(Grid source, T item,
Column column, MouseEventDetails mouseEventDetails) {
super(source, mouseEventDetails);
this.item = item;
this.column = column;
}
/**
* Returns the item of the row where the click event originated.
*
* @return the item of the clicked row
* @since 8.0
*/
public T getItem() {
return item;
}
/**
* Returns the {@link Column} where the click event originated.
*
* @return the column of the click event
*/
public Column getColumn() {
return column;
}
}
/**
* Creates a new clickable renderer with the given presentation type. No
* null representation will be used.
*
* @param presentationType
* the data type that this renderer displays, not
* null
*/
protected ClickableRenderer(Class presentationType) {
this(presentationType, null);
}
/**
* Creates a new clickable renderer with the given presentation type and
* null representation.
*
* @param presentationType
* the data type that this renderer displays, not
* null
* @param nullRepresentation
* a string that will be sent to the client instead of a regular
* value in case the actual cell value is null. May
* be null.
*/
protected ClickableRenderer(Class presentationType,
String nullRepresentation) {
super(presentationType, nullRepresentation);
registerRpc((RendererClickRpc) (String rowKey, String columnId,
MouseEventDetails mouseDetails) -> {
Grid grid = getParentGrid();
T item = grid.getDataCommunicator().getKeyMapper().get(rowKey);
Column column = getParent();
fireEvent(
new RendererClickEvent<>(grid, item, column, 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, not null
* @since 8.0
*/
public Registration addClickListener(RendererClickListener listener) {
return addListener(RendererClickEvent.class, listener,
RendererClickListener.CLICK_METHOD);
}
/**
* Removes the given click listener from this renderer.
*
* @param listener
* the click listener to be removed
*/
@Deprecated
public void removeClickListener(RendererClickListener listener) {
removeListener(RendererClickEvent.class, listener);
}
@Override
protected ClickableRendererState getState() {
return (ClickableRendererState) super.getState();
}
@Override
protected ClickableRendererState getState(boolean markAsDirty) {
return (ClickableRendererState) super.getState(markAsDirty);
}
}