com.raritantechnologies.searchApp.taglibrary
Class SimpleTabRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.TabRenderer
      com.raritantechnologies.searchApp.taglibrary.DHTMLTabRenderer
          com.raritantechnologies.searchApp.taglibrary.SimpleTabRenderer

All Implemented Interfaces:

IConfigurable, ISessionDataHandler

Direct Known Subclasses:

ImageTabRenderer

public class SimpleTabRenderer

extends DHTMLTabRenderer

Renders folder-style tabs. Can use simple line images or CSS styles (inline or css classes).

XML Configuration Template:

  <TabRenderer class="com.raritantechnologies.searchApp.taglibrary.SimpleTabRenderer" 
                  initialTab="[tabID to set active initially ]"
                  tabSetName="[ name of tab set used in javascript ]"
                  tabSetParam="[request param name used to set tab]"
                  tabFormName="[name of form in which this tab will be used]"
                  visibleDivStyle="[div style for visible tab]"
                  hiddenDivStyle="[div style for hidden tab]"
                  leftTabImg="[image link for left side of tab]"
                  rightTabImg="[image link for right side of tab]"
                  pxImg="[image link for top]"
                  lineImg="[image for tab line]"
                  activeColor="[rgb color for background of active tab]"
                  inactiveColor="[rgb color for background of inactive tab]"
                  activeStyle="[ inline style for active tab ]"
                  inactiveStyle="[ inline style for inactive tab ]"
                  activeClass="[ css class for active tab ]"
                  inactiveClass="[ css class for inactive tab ]" >

    <!-- One or more Tab elements: -->
    <Tab ID="tabID" display="display name" />
    <Tab ID="[another tabID]" display="[ tab text ]" />

    <!-- Alternatively - can use IRequestFormatter to get the tab name dynamically -->
    <Tab ID="tabID" >
      <RequestFormatter class="[ class of com.raritantechnologies.quickstart.taglibrary.request.IRequestFormatter ]" >

      </RequestFormatter>
    </Tab>

    <!-- etc... -->

    <!-- Auxilliary Javascript function to be called when tab is selected -->
    <OnChangeFunction name="[ name of changeFunction ]" >
       <!-- custom javascript function here... -->
    </OnChangeFunction>

    <!-- Optional HTML to be added below the Tabs table -->
    <HTMLTrailer>
      <![CDATA[  HTML to be appended to the Tabs table ]]>
    </HTMLTrailer>

  </TabRenderer>
 

Example Display:


Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected java.util.ArrayList

tabNameList

Fields inherited from class com.raritantechnologies.searchApp.taglibrary.DHTMLTabRenderer

hiddenDivStyle, isPersistent, visibleDivStyle

Fields inherited from class com.raritantechnologies.searchApp.taglibrary.TabRenderer

action, auxTabFunction, auxTabScript, createForm, hideOnMap, initialTab, needsResultSet, renderDivs, showOnMap, tabFormName, tabNameMap, tabSetName, tabSetParam

Constructor Summary

SimpleTabRenderer()

Method Summary

protected java.lang.String	doRenderTabs(java.util.Iterator tabNames, java.lang.String activeTab, RaritanPageContext pageContext) Creates HTML for tab set.
protected void	getHyperlink(java.lang.StringBuffer strbuf, java.lang.String tabID, java.lang.String name)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
java.lang.String	renderBody(java.lang.String tabName, java.lang.String tabBody, RaritanPageContext pageContext) Renders the tab body given the tab name and an HTML fragment that will be incorporated into the tab body.
protected java.lang.String	renderTheTabs(java.lang.String activeTab, RaritanPageContext pageContext)

Methods inherited from class com.raritantechnologies.searchApp.taglibrary.DHTMLTabRenderer

getHiddenDivStyle, getRenderedBodies, getTabJavascript, getVisibleDivStyle, renderTabs, setHiddenDivStyle, setVisibleDivStyle

Methods inherited from class com.raritantechnologies.searchApp.taglibrary.TabRenderer

addTab, clearTabMap, getActiveTab, getDisplayName, getOnSubmitHandler, getOnSubmitHandler, getSubmitHandlerName, getTabNameMap, getTabSetParam, handleSessionData, isActive, registerDataHandler, renderTabForm, setAuxilliaryFunction, setAuxilliaryJavascript, setCreateForm, setInitialTab, setTabFormName, setTabSetName, setTabSetParam, updateContext, updateContext

Methods inherited from class java.lang.Object

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

Field Detail

tabNameList

protected java.util.ArrayList tabNameList

Constructor Detail

SimpleTabRenderer

public SimpleTabRenderer()

Method Detail

initialize

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

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

Overrides:

initialize in class DHTMLTabRenderer

doRenderTabs

protected java.lang.String doRenderTabs(java.util.Iterator tabNames,
                                        java.lang.String activeTab,
                                        RaritanPageContext pageContext)

Description copied from class: TabRenderer

Creates HTML for tab set.

Specified by:

doRenderTabs in class TabRenderer

Parameters:

tabNames - Ordered list of java.lang.String with the display name of each tab.

Returns:

HTML fragment for the tab set.

renderTheTabs

protected java.lang.String renderTheTabs(java.lang.String activeTab,
                                         RaritanPageContext pageContext)

getHyperlink

protected void getHyperlink(java.lang.StringBuffer strbuf,
                            java.lang.String tabID,
                            java.lang.String name)

renderBody

public java.lang.String renderBody(java.lang.String tabName,
                                   java.lang.String tabBody,
                                   RaritanPageContext pageContext)

Description copied from class: TabRenderer

Renders the tab body given the tab name and an HTML fragment that will be incorporated into the tab body.

Overrides:

renderBody in class DHTMLTabRenderer