|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.docmosis.template.population.render.FieldDetails
public class FieldDetails
This object provides all the information about a field to be rendered.
Constructor Summary | |
---|---|
FieldDetails(String fieldName,
String fieldValue,
String rendererName,
int rowNum,
Class valueClass,
Object valueObject,
Class containerClass,
Object containerObject,
String id,
String[] params,
DataProvider[] dataProviderLineage,
com.docmosis.template.population.render.TemplateVariablesAccessor templateVariablesAccessor)
|
Method Summary | |
---|---|
Class |
getContainerClass()
Get the class of the container Java object providing the data (if from reflection). |
Object |
getContainerObject()
Get the actual Java object that was queried to obtain the valueObject. |
DataProvider[] |
getDataProviderLineage()
Get the lineage of DataProviders starting with the data provider that contains the current value, then the parent DataProvider, then the grand parent etc. |
String |
getFieldName()
Get the name of the field. |
String |
getFieldValue()
Get the value to be displayed. |
String |
getId()
Get the id for this field if one was specified in the template. |
String |
getRendererName()
Get the name of the renderer. |
String[] |
getRendererParams()
Get any parameters specified for a renderer. |
int |
getRowNum()
Get the row number if in a repeating table. |
String |
getTemplateVariable(String name)
Get a template variable value at the point of processing when the related renderer has been called. |
Class |
getValueClass()
Get the class of the value (if the value was obtained from reflection). |
Object |
getValueObject()
Get the value in its original form (if the value was obtained from reflection). |
void |
setTemplateVariable(String name,
Object value)
Set a template variable at this point of processing in the template. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FieldDetails(String fieldName, String fieldValue, String rendererName, int rowNum, Class valueClass, Object valueObject, Class containerClass, Object containerObject, String id, String[] params, DataProvider[] dataProviderLineage, com.docmosis.template.population.render.TemplateVariablesAccessor templateVariablesAccessor)
Method Detail |
---|
public Class getContainerClass()
public Object getContainerObject()
public String getFieldName()
public String getFieldValue()
public String getRendererName()
public int getRowNum()
public Class getValueClass()
public Object getValueObject()
public String getId()
public String[] getRendererParams()
public DataProvider[] getDataProviderLineage()
public String getTemplateVariable(String name) throws FieldRendererException
name
- the name of the template variable (eg "name" or "$name" - either is accepted).
FieldRendererException
- if the template variable is not set.public void setTemplateVariable(String name, Object value) throws FieldRendererException
name
- the name of the template variable (eg "name" or "$name" - either is accepted).value
- a new value which can use typical template syntax such as expressions and other variables.
FieldRendererException
- if a problem occurs setting the variable.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |