Docmosis API 3.0.1

com.docmosis.template.population.render
Interface FieldRenderer

All Known Implementing Classes:
AlternatingTableRowRenderer, BooleanRenderer, DateRenderer

public interface FieldRenderer

This interface defines an object that can provide particular formatting features for a renderer. The implementing class should make adjustments to the given RenderedField as applicable and then return it.


Method Summary
 RenderedField render(FieldDetails fieldDetails, RenderedField field)
          Make rendering adjustments for a field.
 

Method Detail

render

public RenderedField render(FieldDetails fieldDetails,
                            RenderedField field)
                     throws FieldRendererException
Make rendering adjustments for a field. Adjustments are made by adjusting the given RenderedField and then returning it, or by creating a new RenderedField instance and returning it. If no adjustments are desired the given RenderedField should be returned unchanged. The FieldDetails object gives details about the field.

Parameters:
fieldDetails - all the details about the field to be rendered.
Returns:
the given RenderedField or a new RenderedField
Throws:
FieldRenderedException - if a problem occurs during rendering.
FieldRendererException

Docmosis API 3.0.1

Copyright © 2011 Docmosis. All Rights Reserved.