BrowseResultsElementRenderer

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 BrowseResultsElementRenderer

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

All Implemented Interfaces:: IConfigurable, ISearchElementRenderer

public class BrowseResultsElementRenderer
extends BasicSearchElementRenderer

Renders a browse terms page. This provides a way to select a search term that is guaranteed to return results from a SearchSource. The browse page in which this renderer is used can be part of a pop-up page activated by a BrowseLinkElementRenderer.

XML Configuration Template:

  <SearchElementRenderer
     rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.BrowseResultsElementRenderer"
     browseClass="com.raritantechnologies.searchApp.browse.Browse"
     directory="[ directory where the browse lists are located ]"
     dbConnection="[ connection manager name for DB browse lists ]"
     table="owner.field"   for DBBrowse only
     field                = "[ browse field to use for browse lookup" WARNING: This field must match the field used in the BrowseLinkElementRenderer that called this. ]"
     fieldParam           = "[ input parameter used to determine the browse field name ]"
     formFieldParam       = "[ input parameter used to determine the destination form field name ]"
     pageSize             = "[ number of rows per page (defaults to 10) ]"
     hitRow               = "[ row number where the hit should appear (defaults to 3) ]"
     hitClass             = "[ css Class for selected elements ]"
     cssClass             = "[ css class for non-selected elements ]"
     selectedText         = "[ Use Selected Values ]"
     nonIndexedCharacters = "[ characters to treat as white space ]"
     canceltext           = "[ Text for cancel button - e.g. 'Cancel' ]"
     selectedImage        = "[ image URL for selected button ]"
     cancelImage          = "[ image URL for cancel button]"
     buttonOrImage        = "[ button|image ]"
     reloadOnExit         = "[ true|false - if true causes a reload of calling page ]"
     displayCount         = "[ true(default)|false - if true, display the counts after the terms ]"
     includeCheckboxes    = "[ true(default)|false - if true, display select checkbox before term ]"
     isPopup              = "[ true(default)|false ]"
     pageControl          = "[ top|bottom(default)|both ]"
     nColumns             = "[ number of columns ]"
     centerPageLinks      = "[ true(default)|false"
     scrollBackDisplay    = "[ display for page back scroll e.g. '&lt;&lt; previous' ]"
     scrollForwardDisplay = "[ display for page forward scroll e.g. 'next &gt;&gt;' ]"
     missingTermTemplate  = "[ message with pattern $TERM for missing term placeholder ]"
     multipleTermDelimiter= "[ delimiter to use for multiple terms - or 'NONE' ]" >

    <!-- Include comparators: One or more IncludeComparator tags -->
    <IncludeComparator class="[ class of com.raritantechnologies.utils.comparators.IComparator ]" >
      <!-- configuration parameters for IComparator -->
    </IncludeComparator>

    <!-- Alternative Hyperlink rendererer -->
    <Hyperlink baseURL="base URL" browseField="[ href field for browse term (if empty will use field name) ]" 
                  requestParams="[ fields to carry from incoming HTTP request ]" >

      <FixedParam name="param name" value="param value" />
    </Hyperlink>

 </SearchElementRenderer>

Developed by Raritan Technologies Inc..

Author:: Kepler Gelotte

Field Summary

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

enabled, name

Constructor Summary
`BrowseResultsElementRenderer()`
`BrowseResultsElementRenderer(java.lang.String field)`

Method Summary
`protected java.lang.String`	`doGetBody(ISearchFormRenderer parent, RaritanPageContext pageContext)`
`java.lang.String`	`getBrowseClass()`
`java.lang.String`	`getCancelImage()`
`java.lang.String`	`getCancelText()`
`java.lang.String`	`getConfigurationXML()`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getCssClass()`
`java.lang.String`	`getDbConnectionName()`
`java.lang.String`	`getDirectory()`
`boolean`	`getDisplayCount()`
`int`	`getHitRow()`
`boolean`	`getIsImage()`
`java.lang.String`	`getNonIndexedCharacters()`
`int`	`getPageSize()`
`boolean`	`getReloadOnExit()`
`java.lang.String`	`getSelectedImage()`
`java.lang.String`	`getSelectedText()`
`java.lang.String`	`getTableName()`
`void`	`initialize(org.w3c.dom.Element elem)` Initialize renderer-specific parameters from the configuration XML tag.
`java.lang.String`	`renderBrowsePage(RaritanPageContext pageContext)`
`void`	`setBrowse(IBrowse browse)`
`void`	`setBrowseClass(java.lang.String browseClass)`
`void`	`setCancelImage(java.lang.String cancelImage)`
`void`	`setCancelText(java.lang.String canceltext)`
`void`	`setCssClass(java.lang.String clazz)`
`void`	`setDbConnectionName(java.lang.String d)`
`void`	`setDirectory(java.lang.String d)`
`void`	`setDisplayCount(boolean c)`
`void`	`setHitRow(int row)`
`void`	`setIsImage(boolean isImage)`
`void`	`setNonIndexedCharacters(java.lang.String nonIndexedCharacters)`
`void`	`setPageSize(int size)`
`void`	`setReloadOnExit(boolean reloadOnExit)`
`void`	`setSelectedImage(java.lang.String selectedImage)`
`void`	`setSelectedText(java.lang.String selectedText)`
`void`	`setTableName(java.lang.String t)`

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail