org.xwiki.displayer.HTMLDisplayer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-displayer Show documentation

XWiki Commons - Displayer

There is a newer version: 16.9.0

Show newest version

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.displayer;

import java.lang.reflect.Type;
import java.util.Map;

import org.xwiki.component.annotation.Role;

/**
 * Generates the HTML used to display the values of a given type {@link T}.
 *
 * @param  the type of values that are being displayed as HTML
 * @version $Id: 3609f9a7c55afff3f49fb33dd89be04d81b02f06 $
 * @since 10.11RC1
 */
@Role
public interface HTMLDisplayer
{
    /**
     * @param type the actual type to use for the display
     * @param value the value to be displayed
     * @return the HTML that can be used to display the given value
     * @throws HTMLDisplayerException if an error occurs during the display
     */
    String display(Type type, T value) throws HTMLDisplayerException;

    /**
     * @param type the actual type to use for the display
     * @param value the value to be displayed
     * @param parameters parameters used while generating the html. Could be the attributes of an input for instance.
     * @return the HTML that can be used to display the given value
     * @throws HTMLDisplayerException if an error occurs during the display
     */
    String display(Type type, T value, Map parameters) throws HTMLDisplayerException;

    /**
     * @param type the actual type to use for the display
     * @param value the value to be displayed
     * @param parameters parameters used while generating the html. Could be the attributes of an input for instance.
     * @param mode the display mode (view, edit, ...)
     * @return the HTML that can be used to display the given value
     * @throws HTMLDisplayerException if an error occurs during the display
     */
    String display(Type type, T value, Map parameters, String mode) throws HTMLDisplayerException;
}