DisplaytagColumnDecorator

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> displaytag >> [ decorator overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.displaytag.decorator.DisplaytagColumnDecorator

SOURCE |

Download org.displaytag.decorator.DisplaytagColumnDecorator

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.displaytag.decorator
Interface DisplaytagColumnDecorator

All Known Implementing Classes:: AutolinkColumnDecorator, DateColumnDecorator, DefaultDecoratorFactory.DeprecatedDecoratorWrapper, EscapeXmlColumnDecorator, MessageFormatColumnDecorator, PageContextPrefixColumnDecorator, PrefixColumnDecorator

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$

Method Summary

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

Method Detail

decorate

public java.lang.Object decorate(java.lang.Object columnValue,
                                 javax.servlet.jsp.PageContext pageContext,
                                 org.displaytag.properties.MediaTypeEnum media)
                          throws org.displaytag.exception.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.