Package org.xwiki.displayer

Interface HTMLDisplayer<T>

  • Type Parameters:
    T - the type of values that are being displayed as HTML
    @Role
public interface HTMLDisplayer<T>
    Generates the HTML used to display the values of a given type HTMLDisplayer.
    Since:
    10.11RC1
    Version:
    $Id: 3609f9a7c55afff3f49fb33dd89be04d81b02f06 $

    • Method Detail

      • display

        String display​(Type type,
               T value)
        throws HTMLDisplayerException
        Parameters:
        type - the actual type to use for the display
        value - the value to be displayed
        Returns:
        the HTML that can be used to display the given value
        Throws:
        HTMLDisplayerException - if an error occurs during the display

      • display

        String display​(Type type,
               T value,
               Map<String,​String> parameters)
        throws HTMLDisplayerException
        Parameters:
        type - the actual type to use for the display
        value - the value to be displayed
        parameters - parameters used while generating the html. Could be the attributes of an input for instance.
        Returns:
        the HTML that can be used to display the given value
        Throws:
        HTMLDisplayerException - if an error occurs during the display

      • display

        String display​(Type type,
               T value,
               Map<String,​String> parameters,
               String mode)
        throws HTMLDisplayerException
        Parameters:
        type - the actual type to use for the display
        value - the value to be displayed
        parameters - parameters used while generating the html. Could be the attributes of an input for instance.
        mode - the display mode (view, edit, ...)
        Returns:
        the HTML that can be used to display the given value
        Throws:
        HTMLDisplayerException - if an error occurs during the display