Class HtmlRenderer

  • All Implemented Interfaces:
    Renderer<String>

    public class HtmlRenderer
    extends Object
    implements Renderer<String>
    Renders a string as HTML into a cell.

    The html string is rendered as is without any escaping. It is up to the developer to ensure that the html string honors the SafeHtml contract. For more information see SafeHtmlUtils.fromSafeConstant(String).

    Since:
    7.4
    Author:
    Vaadin Ltd
    See Also:
    SafeHtmlUtils.fromSafeConstant(String)
    • Constructor Detail

      • HtmlRenderer

        public HtmlRenderer()
    • Method Detail

      • render

        public void render​(RendererCellReference cell,
                           String htmlString)
        Description copied from interface: Renderer
        Called whenever the Grid updates a cell.

        For optimal performance, work done in this method should be kept to a minimum since it will be called continuously while the user is scrolling. It is recommended to set up the cell's DOM structure in ComplexRenderer.init(RendererCellReference) and only make incremental updates based on cell data in this method.

        Specified by:
        render in interface Renderer<String>
        Parameters:
        cell - The cell. Note that the cell is a flyweight and should not be stored outside of the method as it will change.
        htmlString - The column data object