SearchFormTableRenderer

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.searchApp.taglibrary
Class SearchFormTableRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicSearchFormRenderer
      com.raritantechnologies.searchApp.taglibrary.SearchFormTableRenderer

All Implemented Interfaces:: IConfigurable, ISearchFormRenderer

public class SearchFormTableRenderer
extends BasicSearchFormRenderer

Configurable Search Form Renderer. Combines one or more nested ISearchElementRenderers into an HTML table to create a search form.

XML Configuration Template:

  <SearchForm name="formName"
         rendererClass="com.raritantechnologies.searchApp.taglibrary.SearchFormTableRenderer"
         cellpadding = "0"
         cellspacing = "2"
         useTable="true"
         border = "1"
         bgcolor="#abcdef"
         formMethod="get(default)|post"
         displayStyle="inline"  // optional - generates style="display:inline"
         includeSessionID="true|false(default)"
         includeFormTag="true(default)|false"
         hAlign="[ left|center|right ]" >

    <!-- One or more SearchElementRenderer elements: -->
    <SearchElementRenderer rendererClass="ASearchElementRenderer class" colspan="[ column span ]" >
      <!-- configuration parameters for search element renderer -->
    </SearchElementRenderer>

    <SearchElementRenderer rendererClass="AnotherSearchElementRenderer class" >
      <!-- configuration parameters for search element renderer -->
    </SearchElementRenderer>

    <!-- Optional onSubmit javascript handler -->
    <SubmitHandler>

    </SubmitHandler>

    <QueryReader class="[Implementation class of IQueryResultSetReader]"
                    applicationName="[ name to use for reading query from DB ]" >
      <!-- Parameters needed by QueryReader class -->
    </QueryReader>

    <!-- SearchParams needed to look up the Query from persistent store using request parameter inputs -->
    <QuerySearchParams>
      <Param ID="[a request param ID]" />
      <Param ID="[another param ID]" />
    </QuerySearchParams>

  </SearchForm>

Developed by Raritan Technologies .

Author:: Ted Sullivan

Field Summary

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

action, afterFormData, category, displayStyle, formInitArgs, formMethod, formName, formType, hiddenFieldMap, hiddenFields, includeResetButton, includeSearchForm, includeSubmitButton, initialFields, onSubmitHandler, operatorMap, scriptMap, sourceMapName, submitButtonOnBottom, submitButtonText, submitHandlerName, targetFrame

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

CLEAR, PAGE, PAGE_NUM, PAGE_SIZE, RESET, SEARCH

Constructor Summary
`SearchFormTableRenderer()`

Method Summary
`void`	`addSearchElementRenderer(ISearchElementRenderer renderer)`
`boolean`	`canUpdateSearchParams()`
`java.lang.String`	`getBackgroundColor()`
`java.lang.String`	`getBody(java.lang.String searchFormName, java.lang.String categoryName, java.lang.String initialFields, java.lang.String hiddenFields, java.lang.String action, java.lang.String formInitArgs, RaritanPageContext pageContext)` Main search form generation method.
`int`	`getBorder()`
`int`	`getCellPadding()`
`int`	`getCellSpacing()`
`java.lang.String`	`getConfigurationXML()`
`boolean`	`getDrawTable()`
`boolean`	`getIncludeSessionID()`
`ISearchElementRenderer[]`	`getSearchElementRenderers()`
`java.lang.String`	`getTableProps()`
`void`	`initialize(org.w3c.dom.Element elem)` Adds configurable properties to the renderer.
`void`	`setBackgroundColor(java.lang.String bgcolor)`
`void`	`setBorder(int border)`
`void`	`setCellPadding(int cellpadding)`
`void`	`setCellSpacing(int cellspacing)`
`void`	`setDrawTable(boolean drawTable)`
`void`	`setIncludeSessionID(boolean includeSessionID)`
`void`	`setSearchElementRenderers(ISearchElementRenderer[] renderers)`
`void`	`setTableProps(java.lang.String tableProps)`
`void`	`updateSearchParams(RaritanPageContext pContext, OrderedMap searchParams)` "callback" loop: SearchFormRenderer responsible for converting requests into one or more query maps.

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

addAfterFormData, addFormScript, addHiddenField, addHiddenFields, addPersistentFields, getActionURL, getCategory, getFormInitArgs, getFormMethod, getFormName, getFormStart, getFormType, getHiddenFields, getInitialFields, getOnSubmitHandler, getSubmitHandlerName, renderHiddenFields, renderScripts, setFormMethod, setFormName, setFormType, setOnSubmitHandler, setSubmitHandlerName

Methods inherited from class java.lang.Object

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

Constructor Detail