com.vaadin.flow.data.renderer.TextRenderer API 24.0.3 | Vaadin

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

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.TextRenderer<ITEM>

Type Parameters:

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

All Implemented Interfaces:

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

A renderer that renders each item as a text using provided ItemLabelGenerator.

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

TextRenderer()

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

TextRenderer(ItemLabelGenerator<ITEM> itemLabelGenerator)

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

Modifier and Type

Method

Description

Component

createComponent(ITEM item)

Creates a component for a given object model item.

protected Element

createElement(String item)

Creates a new Element that represent the rendered 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
- TextRenderer
  
  public TextRenderer()
  
  Creates a new renderer instance using the default ItemLabelGenerator: String::valueOf.
- TextRenderer
  
  public TextRenderer(ItemLabelGenerator<ITEM> itemLabelGenerator)
  
  Creates a new renderer instance using the provided itemLabelGenerator.
  
  Parameters:
  
  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
- createElement
  
  protected Element createElement(String item)
  
  Creates a new Element that represent the rendered item.
  By default the text is wrapped inside a <span> element. Subclasses may override this method to return some other Element.
  
  Parameters:
  
  item - the item to render
  
  Returns:
  
  the element representing rendered item