SwitchableSearchElementRenderer

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.forms
Class SwitchableSearchElementRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicSearchElementRenderer
      com.raritantechnologies.quickstart.taglibrary.forms.SwitchableSearchElementRenderer

All Implemented Interfaces:: IConfigurable, ISearchElementRenderer, ISessionDataHandler

public class SwitchableSearchElementRenderer
extends BasicSearchElementRenderer
implements ISessionDataHandler

Renders a switchable ISearchElementRenderer: A SearchForm element that can be switched on and off on the user interface. Switching is done using DHTML and the switched state is maintained via javascript methods coordinated with the server-side SessionDataManager.

XML Configuration Template:

  <SearchElementRenderer 
     rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.SwitchableSearchElementRenderer" 
     onStart="[show|hide]" 
     onDivStyle="[ div style of ON state ex:   visibility:visible;overflow:scroll;padding-left:5px;padding-top: ]"
     offDivStyle="[ div style of OFF state ex: visibility:hidden;overflow:scroll;padding-left:5px;padding-top:  ]"
     displayTitle="[ display text of checkbox ]"
     displayClass="css class for checkbox text"
     shouldRegister="false"
     useTable="true"  >

      <!-- Nested SearchElementRenderer  -->
      <SearchElementRenderer rendererClass ="A real SearchElementRenderer goes here]" >
        <!-- parameters needed by the nested renderer -- >
      </SearchElementRenderer>

  </SearchElementRenderer>

Developed by Raritan Technologies .

Author:: Ted Sullivan

Field Summary

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

name

Constructor Summary
`SwitchableSearchElementRenderer()`

Method Summary
`java.lang.String`	`doGetBody(ISearchFormRenderer parent, RaritanPageContext pageContext)`
`ISearchElementRenderer`	`getChildRenderer()`
`java.lang.String`	`getConfigurationXML()`
`java.lang.String`	`getDelimiter()`
`java.lang.String`	`getDisplayClass()`
`java.lang.String`	`getDisplayTitle()`
`java.lang.String`	`getOffDivStyle()`
`java.lang.String`	`getOnDivStyle()`
`ISearchElementRenderer`	`getRenderer(java.lang.String name)` Returns ISearchElementRenderer of this render or a nested renderer matching the name given or null if no match is found.
`boolean`	`getShouldRegister()`
`boolean`	`getStartsOn()`
`boolean`	`getUseTable()`
`void`	`handleSessionData(java.util.Map sessionDataMap, RaritanPageContext req)` makes sure than any request parameters that this handler is interested in are conveyed to the SessionData map.
`void`	`initialize(org.w3c.dom.Element elem)` Initialize renderer-specific parameters from the configuration XML tag.
`void`	`registerDataHandler(ISessionDataManager manager, java.util.Map params)` requires InitParam map with "formName" = search form name
`void`	`setChildRenderer(ISearchElementRenderer childRenderer)`
`void`	`setDelimiter(java.lang.String delimiter)`
`void`	`setDisplayClass(java.lang.String displayClass)`
`void`	`setDisplayTitle(java.lang.String displayTitle)`
`void`	`setOffDivStyle(java.lang.String offDivStyle)`
`void`	`setOnDivStyle(java.lang.String onDivStyle)`
`void`	`setShouldRegister(boolean shouldRegister)`
`void`	`setStartsOn(boolean startsOn)`
`void`	`setUseTable(boolean useTable)`

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

doGetBodyDisabled, getBody, getInitValue, getInitValue, getInitValue, isHidden, setEnable

Methods inherited from class java.lang.Object

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

Constructor Detail