com.raritantechnologies.searchApp.taglibrary
Class BasicDisplayFormRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicDisplayFormRenderer

All Implemented Interfaces:

IConfigurable, IDisplayFormRenderer

Direct Known Subclasses:

AtomDisplayFormRenderer, NumberResultsRenderer, RSSDisplayFormRenderer, SortHeaderRenderer, SpacerRenderer, TreeDisplayFormRenderer

public class BasicDisplayFormRenderer

extends java.lang.Object

implements IDisplayFormRenderer

"Plain vanilla" display form renderer: Renders a Basic HTML table with two columns: field name | field value.

XML Configuration Template:

  <DisplayForm name="[ name of the DisplayForm ]" 
      rendererClass="com.raritantechnologies.searchApp.taglibrary.BasicDisplayFormRenderer"
      bgcolor1="[ RGB color for odd columns (default='#ffffff' ) ]"
      bgcolor2="[ RGB color for even columns (default='#eeeeee') ]"
      fieldNameClass="[ CSS font for field name column ]"
      fieldValueClass="[ CSS font for field value column ]"
      colspacing="[ spacing between columns (default=0) ]" 
      headerWidth="[ width of header column (default=200) ]"
      resultWidth="[ width of result value column (default=640) ]"
      noResultsMessage="[ message if no results (can be blank ) ]" >

    <!-- One or more Field tags. If no Field tags are put in, the renderer will render all IResult fields -->
    <Field ID="[ result field ID ]" type="text" name="[ field display name ]" />
    <Field ID="[ result field ID ]" type="text" name="[ field display name ]" />

    <!-- etc. . . -->

  </DisplayForm>
 

Sample HTML output:

Author		C. Peter Waegemann
Article Title		LEADING EDGE--An Electronic Health Record for the Real World
Author		Claudia Tessier
Article Title		The Essentials of Healthcare Documentation

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected java.lang.StringBuffer

trailerBuffer

Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer

TEMPLATE

Constructor Summary

BasicDisplayFormRenderer()

Method Summary

void	addBodyTrailerContent(java.lang.String content) Add html content to be appended to the body of the displayFormRenderer
void	disableRenderers(java.util.HashSet disabledRenderers)
void	enableRenderers(java.util.HashSet enabledRenderers)
java.lang.String	getBody(IResultSet theResults, java.lang.String displayFormName, RaritanPageContext pageContext) returns the HTML fragment for the given set of results.
java.lang.String	getConfigurationXML()
IResultRenderer	getResultRenderer(java.lang.String name)
void	initialize(org.w3c.dom.Element elem) Initialize the display form renderer from the configuration XML.
void	initialize(java.util.Map renderParams) Initialize the display form renderer from a set of configuration parameters.
void	setBackgroundColor1(java.lang.String bgcolor1)
void	setBackgroundColor2(java.lang.String bgcolor2)
void	setColumnSpacing(java.lang.String colspacing)
void	setDisabledRendererParam(java.lang.String disabledParam)
void	setEnabledRendererParam(java.lang.String enabledParam)
void	setEnabledRenderers(java.lang.String displayForm, RaritanPageContext pageContext)
void	setFieldNameCSSClass(java.lang.String fieldNameClass)
void	setFielValueCSSClass(java.lang.String fieldValueClass)
void	setHeaderWidth(java.lang.String headerWidth)
void	setResultWidth(java.lang.String resultWidth)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

trailerBuffer

protected java.lang.StringBuffer trailerBuffer

Constructor Detail

BasicDisplayFormRenderer

public BasicDisplayFormRenderer()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Initialize the display form renderer from the configuration XML.

Specified by:

initialize in interface IDisplayFormRenderer

initialize

public void initialize(java.util.Map renderParams)

Initialize the display form renderer from a set of configuration parameters.

getBody

public java.lang.String getBody(IResultSet theResults,
                                java.lang.String displayFormName,
                                RaritanPageContext pageContext)

returns the HTML fragment for the given set of results.

Specified by:

getBody in interface IDisplayFormRenderer

addBodyTrailerContent

public void addBodyTrailerContent(java.lang.String content)

Description copied from interface: IDisplayFormRenderer

Add html content to be appended to the body of the displayFormRenderer

Specified by:

addBodyTrailerContent in interface IDisplayFormRenderer

getResultRenderer

public IResultRenderer getResultRenderer(java.lang.String name)

Specified by:

getResultRenderer in interface IDisplayFormRenderer

setEnabledRendererParam

public void setEnabledRendererParam(java.lang.String enabledParam)

Specified by:

setEnabledRendererParam in interface IDisplayFormRenderer

setDisabledRendererParam

public void setDisabledRendererParam(java.lang.String disabledParam)

Specified by:

setDisabledRendererParam in interface IDisplayFormRenderer

setEnabledRenderers

public void setEnabledRenderers(java.lang.String displayForm,
                                RaritanPageContext pageContext)

Specified by:

setEnabledRenderers in interface IDisplayFormRenderer

enableRenderers

public void enableRenderers(java.util.HashSet enabledRenderers)

Specified by:

enableRenderers in interface IDisplayFormRenderer

disableRenderers

public void disableRenderers(java.util.HashSet disabledRenderers)

Specified by:

disableRenderers in interface IDisplayFormRenderer

setBackgroundColor1

public void setBackgroundColor1(java.lang.String bgcolor1)

setBackgroundColor2

public void setBackgroundColor2(java.lang.String bgcolor2)

setFieldNameCSSClass

public void setFieldNameCSSClass(java.lang.String fieldNameClass)

setFielValueCSSClass

public void setFielValueCSSClass(java.lang.String fieldValueClass)

setColumnSpacing

public void setColumnSpacing(java.lang.String colspacing)

setHeaderWidth

public void setHeaderWidth(java.lang.String headerWidth)

setResultWidth

public void setResultWidth(java.lang.String resultWidth)

getConfigurationXML

public java.lang.String getConfigurationXML()