Docmosis API 4.5.0

com.docmosis.template.population.render
Class RenderedField

java.lang.Object
  extended bycom.docmosis.template.population.render.RenderedField

public class RenderedField
extends Object

A "logical" rendered field providing the actual rendering classes with information that can change presentation of the field.


Constructor Summary
RenderedField()
           
 
Method Summary
 boolean getBold()
          Determine whether to add the bold font attribute.
 boolean getItalic()
          Determine whether to add the italic font attribute.
 String getTableCellBackgroundColour()
          Get the background cell colour.
 boolean getUnderline()
          Determine whether to add the underline font attribute.
 String getValue()
          Get the text value to display.
 void setBold(boolean bold)
          Specify whether to add the bold font attribute.
 void setCellBackgroundColour(String cellBgColour)
          Set the background colour of the table cell containing the field (if applicable).
 void setItalic(boolean italic)
          Specify whether to add the italic font attribute.
 void setUnderline(boolean underline)
          Specify whether to add the underline font attribute.
 void setValue(String value)
          Set the text to display for the field.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RenderedField

public RenderedField()
Method Detail

getTableCellBackgroundColour

public String getTableCellBackgroundColour()
Get the background cell colour. This only applies to fields within a table cell. Returning null means the cell colour will be left as is.

Returns:
null or a #RRGGBB colour string

setCellBackgroundColour

public void setCellBackgroundColour(String cellBgColour)
Set the background colour of the table cell containing the field (if applicable). A typical RGB colour string is used of the form
 #RRGGBB where 
   RR = red
   GG = green
   BB = blue
 
and each pair has values from 00 (zero) to FF (full).

Parameters:
cellBgColour - the RGB colour value #RRGGBB

getValue

public String getValue()
Get the text value to display.

Returns:
null if no value

setValue

public void setValue(String value)
Set the text to display for the field. This method allows a renderer to change the actual value to be rendered from the value obtained from the data provider. Returning null means the value will be left unchanged.

Returns:
null or the value

getBold

public boolean getBold()
Determine whether to add the bold font attribute.

Returns:
true if the value should be bold

setBold

public void setBold(boolean bold)
Specify whether to add the bold font attribute.

Returns:
true if the value should be bold

getItalic

public boolean getItalic()
Determine whether to add the italic font attribute.

Returns:
true if the value should be italicised

setItalic

public void setItalic(boolean italic)
Specify whether to add the italic font attribute.

Returns:
true if the value should be italicised

getUnderline

public boolean getUnderline()
Determine whether to add the underline font attribute.

Returns:
true if the value should be underlined

setUnderline

public void setUnderline(boolean underline)
Specify whether to add the underline font attribute.

Returns:
true if the value should be underlined

Docmosis API 4.5.0

Copyright © 2014 Docmosis Pty Ltd. All Rights Reserved.