com.vaadin.flow.data.renderer.IconRenderer API 24.7.0.alpha6 | Vaadin

com.vaadin.flow.data.renderer.

java.lang.Object

com.vaadin.flow.data.renderer.Renderer<SOURCE>

com.vaadin.flow.data.renderer.LitRenderer<SOURCE>

com.vaadin.flow.data.renderer.ComponentRenderer<Component,ITEM>

com.vaadin.flow.data.renderer.IconRenderer<ITEM>

Type Parameters:

ITEM - the type of the input object that can be used by the rendered component

All Implemented Interfaces:

public class IconRenderer<ITEM> extends ComponentRenderer<Component,ITEM>

A renderer that renders each item as a text following by an icon using provided icon generator and label generator.

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator)

Creates a new renderer instance using the default ItemLabelGenerator: String::valueOf and the provided iconGenerator.

IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator, ItemLabelGenerator<ITEM> itemLabelGenerator)

Creates a new renderer instance using the provided iconGenerator and itemLabelGenerator.
Method Summary

Modifier and Type

Method

Description

Component

createComponent(ITEM item)

Creates a component for a given object model item.

Methods inherited from class com.vaadin.flow.data.renderer.ComponentRenderer
getTemplateExpression, render, updateComponent

Methods inherited from class com.vaadin.flow.data.renderer.LitRenderer
getValueProviders, of, withFunction, withFunction, withProperty

Methods inherited from class com.vaadin.flow.data.renderer.Renderer
render

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- IconRenderer
  
  public IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator)
  
  Creates a new renderer instance using the default ItemLabelGenerator: String::valueOf and the provided iconGenerator.
  
  Parameters:
  
  iconGenerator - the icon component generator
- IconRenderer
  
  public IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator, ItemLabelGenerator<ITEM> itemLabelGenerator)
  
  Creates a new renderer instance using the provided iconGenerator and itemLabelGenerator.
  
  Parameters:
  
  iconGenerator - the icon component generator
  
  itemLabelGenerator - the item label generator
Method Details
- createComponent
  
  public Component createComponent(ITEM item)
  
  Description copied from class: ComponentRenderer
  
  Creates a component for a given object model item. Subclasses can override this method to provide specific behavior.
  
  Overrides:
  
  createComponent in class ComponentRenderer<Component,ITEM>
  
  Parameters:
  
  item - the model item, possibly null
  
  Returns:
  
  a component instance representing the provided item