planetj.helpers
Interface IPDFField

All Superinterfaces:

INamed

All Known Implementing Classes:

Field

public interface IPDFField

extends INamed

Author:

Justin

Method Summary

java.awt.Color	getBackgroundColor(ExecutingContext ec) Gets the background of this field when it is rendered in a PDF document
int	getColumnSpan(boolean isDetails) Get the number of columns this field should take up.
short	getHorizontalAlignment(ExecutingContext ec) Gets the alignment for the field
java.lang.Object	getPDFValue(PDFFileDescriptor descriptor) Gets the display value of this field when it is rendered in a PDF document

Methods inherited from interface planetj.util.INamed

getName, getValue

Method Detail

getPDFValue

public java.lang.Object getPDFValue(PDFFileDescriptor descriptor)
                             throws CMException

Gets the display value of this field when it is rendered in a PDF document

Throws:

CMException

getBackgroundColor

public java.awt.Color getBackgroundColor(ExecutingContext ec)
                                  throws CMException

Gets the background of this field when it is rendered in a PDF document

Throws:

CMException

getHorizontalAlignment

public short getHorizontalAlignment(ExecutingContext ec)
                             throws CMException

Gets the alignment for the field

Throws:

CMException

getColumnSpan

public int getColumnSpan(boolean isDetails)

Get the number of columns this field should take up.

Parameters:

isDetails - whether or not its details or results table being generated