TableDisplayFormRenderer

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.raritantechnologies.quickstart.taglibrary
Class TableDisplayFormRenderer

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.TableDisplayFormRenderer

All Implemented Interfaces:: IConfigurable, IDisplayFormRenderer

Direct Known Subclasses:: GridDisplayFormRenderer

public class TableDisplayFormRenderer
extends java.lang.Object
implements IDisplayFormRenderer

Renderers a table view of results. Uses an IResultRenderer to render each result row.

Can create arbitrarily complex result displays using ResultColumnRenderer and com.raritantechnologies.quickstart.taglibraryResultRowRenderer.

XML Configuration Template:

  <DisplayForm name="formName" 
              rendererClass="com.raritantechnologies.quickstart.taglibrary.TableDisplayFormRenderer"
              tableProps="[ table properties ]"
              trProps="[ row properties ]"
              bgcolor1="[ RGB color for odd rows (default='#ffffff') ]" 
              bgcolor2="[ RGB color for even rows (default='#ffffff) ]"
              noResultsMessage="[ message for zero results e.g. 'Your Search Returned 0 Results' ]"
              diagnosticMessage="[ optional message for null result set e.g. 'ResultSet is NULL!' ]"
              nColumns="[ number of result columns (default=1) ]"
              useTable="[ true(default)|false ]"
              useRows="[ true(default)|false ]"
              cacheName="[ name to cache display table ]"
              cacheOnParams="[ request params to switch table display ]" >

    <!-- standard field list use with TableResultRenderer -->
    <Field ID="F1" type="text" width="50" name="Field 1" />
    <Field ID="F2" type="text" width="50" name="Field 2" />

    <!-- OR can specify a result renderer -->
    <ResultRenderer rendererClass="someResultRendererClass" />
  </DisplayForm>

Developed by Raritan Technologies Inc..

Author:: Ted Sullivan

Field Summary
`static boolean`	`DEBUG`
`static java.lang.String`	`RESULT_REND`

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

TEMPLATE

Constructor Summary
`TableDisplayFormRenderer()`

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)`
`protected java.lang.String`	`doGetBody(IResultSet theResults, java.lang.String displayForm, RaritanPageContext pageContext)`
`void`	`enableRenderers(java.util.HashSet enabledRenderers)`
`java.lang.String`	`getBackgroundColor1()`
`java.lang.String`	`getBackgroundColor2()`
`java.lang.String`	`getBody(IResultSet theResults, java.lang.String displayForm, RaritanPageContext pageContext)` Returns the display form body as an HTML fragment, by formatting the data contained in an IResultSet.
`java.lang.String`	`getConfigurationXML()`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getDiagnosticMessage()`
`java.lang.String`	`getDisabledRendererParam()`
`java.lang.String`	`getEnabledRendererParam()`
`int`	`getNColumns()`
`java.lang.String`	`getNoResultsMessage()`
`IResultRenderer`	`getResultRenderer()`
`IResultRenderer`	`getResultRenderer(java.lang.String name)`
`java.lang.String`	`getTableProps()`
`boolean`	`getUseRows()`
`boolean`	`getUseTable()`
`java.lang.String`	`getWidth()`
`void`	`initialize(org.w3c.dom.Element elem)` Initialize the display form renderer from the configuration XML.
`void`	`setBackgroundColor1(java.lang.String bgcolor1)`
`void`	`setBackgroundColor2(java.lang.String bgcolor2)`
`void`	`setDiagnosticMessage(java.lang.String diagnosticMessage)`
`void`	`setDisabledRendererParam(java.lang.String disabledParam)`
`void`	`setEnabledRendererParam(java.lang.String enabledParam)`
`void`	`setEnabledRenderers(java.lang.String displayForm, RaritanPageContext pageContext)`
`java.lang.String[]`	`setFieldIDs()`
`void`	`setFieldIDs(java.lang.String[] fieldIDs)`
`void`	`setNColumns(int nColumns)`
`void`	`setNoResultsMessage(java.lang.String noResultsMessage)`
`void`	`setResultRenderer(IResultRenderer resultRenderer)`
`void`	`setTableProps(java.lang.String tableProps)`
`void`	`setUseRows(boolean useRows)`
`void`	`setUseTable(boolean useTable)`
`void`	`setWidth(java.lang.String width)`

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final boolean DEBUG

See Also:: Constant Field Values

RESULT_REND

public static final java.lang.String RESULT_REND

See Also:: Constant Field Values

Constructor Detail