Docmosis API 4.5.0

com.docmosis.template.population.render
Class BooleanRenderer

java.lang.Object
  extended bycom.docmosis.template.population.render.BooleanRenderer
All Implemented Interfaces:
FieldRenderer

public class BooleanRenderer
extends Object
implements FieldRenderer

A Boolean Renderer that supports a single parameter specifying the way to render the boolean. The following values may be specified via the parameter:

   none         = true is rendered as "true" and false as "false"
   "yn"         = true is rendered as "Y" and false as "N"
   "ynlc"       = true is rendered as "y" and false as "n" (lower case)
   "yesnouc"    = true is rendered as "YES" and false as "NO" (upper case)
   "yesnolc"    = true is rendered as "yes" and false as "no"
   "yesno"      = true is rendererd as "Yes" and false as "No" (mixed case)
   "wingdings1" = true is rendered as a wingdings tick and false as a cross
   "wingding2"  = true is rendered as a wingdings checkbox ticked and false as unticked
   "dingbats1"  = true is rendered as a dingbats light tick and light cross  
   "dingbats2"  = true is rendered as a dingbats heavy tick and heavy cross  
 
The wingdings and dingbats settings require the template to have the field formatted in the template in the wingdings and dingbats fonts respectively. Wingdings and dingbats require the corresponding font to be available. Dingbats typically won't work with Word templates and documents. This class is thread safe.


Constructor Summary
BooleanRenderer()
           
 
Method Summary
 RenderedField render(FieldDetails details, RenderedField renderedField)
          Make rendering adjustments for a field.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BooleanRenderer

public BooleanRenderer()
Method Detail

render

public RenderedField render(FieldDetails details,
                            RenderedField renderedField)
                     throws FieldRendererException
Description copied from interface: FieldRenderer
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.

Specified by:
render in interface FieldRenderer
Parameters:
details - all the details about the field to be rendered.
Returns:
the given RenderedField or a new RenderedField
Throws:
FieldRendererException

Docmosis API 4.5.0

Copyright © 2014 Docmosis Pty Ltd. All Rights Reserved.