org.displaytag.decorator
Interface DisplaytagColumnDecorator

All Known Implementing Classes:

AutolinkColumnDecorator, EscapeXmlColumnDecorator, MessageFormatColumnDecorator

public interface DisplaytagColumnDecorator

Interface for simple column decorators.

A column decorator is called after the object has been retrieved and it can "transform" the object before the rendering.

The DisplaytagColumnDecorator interface has been introduced in displaytag 1.1 and replaces the previous ColumnDecorator interface, adding the pageContext and media parameters, and changing the return type to object to allow decorator chaining.

Since:

1.1

Version:

$Id$

Author:

Fabrizio Giustina

Method Summary

java.lang.Object

decorate(java.lang.Object columnValue, javax.servlet.jsp.PageContext pageContext, MediaTypeEnum media) Called after the object has been retrieved from the bean contained in the list.

Method Detail

decorate

java.lang.Object decorate(java.lang.Object columnValue,
                          javax.servlet.jsp.PageContext pageContext,
                          MediaTypeEnum media)
                          throws DecoratorException

Called after the object has been retrieved from the bean contained in the list. The decorate method is responsible for transforming the object into a string to render in the page.

Parameters:

columnValue - Object to decorate

pageContext - jsp page context

media - current media (html, pdf, excel...)

Returns:

Object decorated object

Throws:

DecoratorException - wrapper exception for any exception thrown during decoration