com.raritantechnologies.quickstart.taglibrary
Class TableResultRenderer

java.lang.Object
  extended bycom.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      extended bycom.raritantechnologies.quickstart.taglibrary.TableResultRenderer
All Implemented Interfaces:
IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class TableResultRenderer
extends BasicResultRenderer
implements IResultRenderer

Renders all of the fields of an IResult as a simple HTML table. Useful for rendering nested results.

XML Configuration Template:
   <ResultRenderer 
      rendererClass="com.raritantechnologies.quickstart.taglibrary.TableResultRenderer"
      tableClass="[ CSS class for table ]"
      labelClass="[ CSS class for result labels ]"
      valueClass="[ CSS class for result values ]"
      bgcolor1="[ RGB color for odd rows (default='#ffffff') ]"
      bgcolor2="[ RGB color for even rows (default='#ffffff') ]"
      nColumns="[ number of table columns (default=1) ]" >

     <!-- One or more Field tags -->
     <Field ID="[ result field ID ]" />
     <Field ID="[ result field ID ]" />

     <!-- etc. . . -->

   </ResultRenderer>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
static java.lang.String FIELD_IDS
           
 
Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
enabled, name, prefBeanName, prefCompareValue, prefEnableIfInChecklist, prefEnableIfInYesno
 
Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer
TEMPLATE
 
Constructor Summary
TableResultRenderer()
           
TableResultRenderer(java.lang.String[] fieldList)
           
 
Method Summary
protected  java.lang.String doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)
           
 java.lang.String getBackgroundColor1()
           
 java.lang.String getBackgroundColor2()
           
 java.lang.String getConfigurationXML()
           
 java.lang.String getConfigurationXML(java.lang.String configurationTemplate)
           
 void getConfigurationXML(java.io.Writer writer)
           
 java.lang.String[] getFieldIDs()
           
 java.lang.String getLabelCssClass()
           
 java.lang.String getLabelVAlign()
           
 int getNColumns()
           
 boolean getResultNumbering()
           
 java.lang.String getTableCssClass()
           
 java.lang.String getValueCssClass()
           
 java.lang.String getValueWidth()
           
 java.lang.String gsetLabelWidth()
           
 void initialize(org.w3c.dom.Element elem)
          IResultRenderers are XML configurable.
 void setBackgroundColor1(java.lang.String bgcolor1)
           
 void setBackgroundColor2(java.lang.String bgcolor2)
           
 void setFieldIDs(java.lang.String[] fieldIDs)
           
 void setFieldList(java.lang.String[] fieldList)
           
 void setLabelCssClass(java.lang.String labelClazz)
           
 void setLabelVAlign(java.lang.String labelVAlign)
           
 void setLabelWidth(java.lang.String labelWidth)
           
 void setNColumns(int nColumns)
           
 void setResultNumbering(boolean resultNumbering)
           
 void setTableCssClass(java.lang.String tableClazz)
           
 void setValueCssClass(java.lang.String valueClazz)
           
 void setValueWidth(java.lang.String valueWidth)
           
 
Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
getPrefBeanName, getPrefCompareValue, getPrefEnableIfInChecklist, getPrefEnableIfInYesno, getRenderer, isEnabled, renderResult, setEnable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer
getRenderer, isEnabled, renderResult, setEnable
 

Field Detail

FIELD_IDS

public static final java.lang.String FIELD_IDS
See Also:
Constant Field Values
Constructor Detail

TableResultRenderer

public TableResultRenderer()

TableResultRenderer

public TableResultRenderer(java.lang.String[] fieldList)
Method Detail

setFieldList

public void setFieldList(java.lang.String[] fieldList)

initialize

public void initialize(org.w3c.dom.Element elem)
Description copied from interface: IResultRenderer
IResultRenderers are XML configurable.

Specified by:
initialize in interface IResultRenderer
Overrides:
initialize in class BasicResultRenderer

doRenderResult

protected java.lang.String doRenderResult(IResult result,
                                          int firstResult,
                                          int lastResult,
                                          int resultNum,
                                          RaritanPageContext pageContext)
Specified by:
doRenderResult in class BasicResultRenderer

setFieldIDs

public void setFieldIDs(java.lang.String[] fieldIDs)

getFieldIDs

public java.lang.String[] getFieldIDs()

setTableCssClass

public void setTableCssClass(java.lang.String tableClazz)

getTableCssClass

public java.lang.String getTableCssClass()

setLabelCssClass

public void setLabelCssClass(java.lang.String labelClazz)

getLabelCssClass

public java.lang.String getLabelCssClass()

setValueCssClass

public void setValueCssClass(java.lang.String valueClazz)

getValueCssClass

public java.lang.String getValueCssClass()

setLabelWidth

public void setLabelWidth(java.lang.String labelWidth)

gsetLabelWidth

public java.lang.String gsetLabelWidth()

setValueWidth

public void setValueWidth(java.lang.String valueWidth)

getValueWidth

public java.lang.String getValueWidth()

setLabelVAlign

public void setLabelVAlign(java.lang.String labelVAlign)

getLabelVAlign

public java.lang.String getLabelVAlign()

setNColumns

public void setNColumns(int nColumns)

getNColumns

public int getNColumns()

setResultNumbering

public void setResultNumbering(boolean resultNumbering)

getResultNumbering

public boolean getResultNumbering()

setBackgroundColor1

public void setBackgroundColor1(java.lang.String bgcolor1)

getBackgroundColor1

public java.lang.String getBackgroundColor1()

setBackgroundColor2

public void setBackgroundColor2(java.lang.String bgcolor2)

getBackgroundColor2

public java.lang.String getBackgroundColor2()

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException
Throws:
java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()
Specified by:
getConfigurationXML in interface IResultRenderer

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)
Specified by:
getConfigurationXML in interface IResultRenderer