com.raritantechnologies.searchApp.taglibrary
Class TabbedDisplayFormRenderer

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

All Implemented Interfaces:

IConfigurable, IDisplayFormRenderer

Direct Known Subclasses:

FederatedTabbedDisplayFormRenderer

public class TabbedDisplayFormRenderer

extends java.lang.Object

implements IDisplayFormRenderer

Renders a tabbed set of Result DisplayForms. Contains a subclass of TabRenderer to handle tab rendering.

XML Configuration Template:

 <DisplayForm name="dispFormName"
                   rendererClass="com.raritantechnologies.searchApp.taglibrary.TabbedDisplayFormRenderer"
                 tabActionURL="jsp page that will redraw the tabbed results" >

   <TabRenderer class="[Tab Renderer class]" >
     <!-- Tabs with ResultMatchers will filter the incoming result set. This will restrict the -->
     <!-- set of results displayed when this tab is selected.                                  -->
     <Tab ID="tabID1"  display="tab display 1" >
        <ResultMatcher class="[ class of com.raritantechnologies.searchApp.IResultMatcher ]" >
        </ResultMatcher>
     </Tab>

     <!-- Tabs without ResultMatchers will display the incoming result set as is -->
     <Tab ID="tabID2" display="tab display 2" />

     <!-- details needed by TabRenderer -->
   </TabRenderer>

    <TabbedForms>
      <Form ID="theTabID" name="[a DisplayForm name]" />
    </TabbedForms>
 </DisplayForm>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected OrderedMap	displayRenderers
protected TabRenderer	tabRenderer

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

TEMPLATE

Constructor Summary

TabbedDisplayFormRenderer()

Method Summary

void	addBodyTrailerContent(java.lang.String content) Add html content to be appended to the body of the displayFormRenderer
protected void	addTabbedForm(java.lang.String tabID, java.lang.String displayRenderer, java.lang.String tabName, IResultMatcher resultMatcher, int totalDocs)
protected void	clearTabs()
void	disableRenderers(java.util.HashSet disabledRenderers)
void	enableRenderers(java.util.HashSet enabledRenderers)
java.lang.String	getBody(IResultSet resultSet, java.lang.String displayFormName, RaritanPageContext pageContext) Returns a Tabbed set of DisplayForms including tab controls.
protected IDisplayFormRenderer	getCurrentRenderer(java.lang.String tabID)
IResultRenderer	getResultRenderer(java.lang.String name)
void	initialize(org.w3c.dom.Element elem) Initialize the search form renderer from the configuration XML.
void	setDisabledRendererParam(java.lang.String disabledParam)
void	setEnabledRendererParam(java.lang.String enabledParam)
void	setEnabledRenderers(java.lang.String displayForm, RaritanPageContext pageContext)

Methods inherited from class java.lang.Object

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

Field Detail

displayRenderers

protected OrderedMap displayRenderers

tabRenderer

protected TabRenderer tabRenderer

Constructor Detail

TabbedDisplayFormRenderer

public TabbedDisplayFormRenderer()

Method Detail

initialize

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

Description copied from interface: IDisplayFormRenderer

Initialize the search form renderer from the configuration XML.

Specified by:

initialize in interface IDisplayFormRenderer

getBody

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

Returns a Tabbed set of DisplayForms including tab controls.

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

getCurrentRenderer

protected IDisplayFormRenderer getCurrentRenderer(java.lang.String tabID)

clearTabs

protected void clearTabs()

addTabbedForm

protected void addTabbedForm(java.lang.String tabID,
                             java.lang.String displayRenderer,
                             java.lang.String tabName,
                             IResultMatcher resultMatcher,
                             int totalDocs)