Package com.vaadin.flow.data.renderer
Class IconRenderer<ITEM>
- java.lang.Object
-
- com.vaadin.flow.data.renderer.Renderer<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:
Serializable
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 defaultItemLabelGenerator
:String::valueOf
and the providediconGenerator
.IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator, ItemLabelGenerator<ITEM> itemLabelGenerator)
Creates a new renderer instance using the providediconGenerator
anditemLabelGenerator
.
-
Method Summary
All Methods Instance Methods Concrete Methods 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
render, setComponentRendererTag, updateComponent
-
Methods inherited from class com.vaadin.flow.data.renderer.Renderer
getEventHandlers, getValueProviders, render, setEventHandler, setProperty
-
-
-
-
Constructor Detail
-
IconRenderer
public IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator)
Creates a new renderer instance using the defaultItemLabelGenerator
:String::valueOf
and the providediconGenerator
.- Parameters:
iconGenerator
- the icon component generator
-
IconRenderer
public IconRenderer(SerializableFunction<ITEM,? extends Component> iconGenerator, ItemLabelGenerator<ITEM> itemLabelGenerator)
Creates a new renderer instance using the providediconGenerator
anditemLabelGenerator
.- Parameters:
iconGenerator
- the icon component generatoritemLabelGenerator
- the item label generator
-
-
Method Detail
-
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 classComponentRenderer<Component,ITEM>
- Parameters:
item
- the model item, possiblynull
- Returns:
- a component instance representing the provided item
-
-