com.vaadin.flow.data.renderer.ClickableRenderer API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.data.renderer.

Type Parameters:

SOURCE - the type of the item received in the click listeners

All Superinterfaces:

Serializable

All Known Implementing Classes:

NativeButtonRenderer
```
public interface ClickableRenderer<SOURCE>
extends Serializable
```
Represents a clickable renderer.

Author:

Vaadin Ltd

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`ClickableRenderer.ItemClickListener<SOURCE>`	Listener that receives the clicked item (or tapped item, in touch devices).

Method Summary

All Methods
Modifier and Type	Method	Description
`Registration`	`addItemClickListener(ClickableRenderer.ItemClickListener<SOURCE> listener)`	Adds a click listener to the renderer.
`List<ClickableRenderer.ItemClickListener<SOURCE>>`	`getItemClickListeners()`	Gets all registered listeners.
`default void`	`onClick(SOURCE item)`	Invoked when an item is clicked or tapped.

- Method Detail
  - addItemClickListener
```
Registration addItemClickListener(ClickableRenderer.ItemClickListener<SOURCE> listener)
```
    Adds a click listener to the renderer. Events are fired when items are clicked or tapped (for touch devices).
    
    Parameters:
    
    listener - the listener to receive click events, not null
    
    Returns:
    
    a registration that can be used to remove the listener from this renderer
  - getItemClickListeners
```
List<ClickableRenderer.ItemClickListener<SOURCE>> getItemClickListeners()
```
    Gets all registered listeners.
    
    Returns:
    
    an unmodifiable list of registered listeners, not null
  - onClick
```
default void onClick(SOURCE item)
```
    Invoked when an item is clicked or tapped. Registered listeners are notified.
    
    Parameters:
    
    item - the clicked or tapped item
    
    See Also:
    
    addItemClickListener(ItemClickListener)