BrowseLinkElementRenderer

Main

Javadoc

Example

Source

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 BrowseLinkElementRenderer

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

All Implemented Interfaces:: IConfigurable, ISearchElementRenderer

public class BrowseLinkElementRenderer
extends BasicSearchElementRenderer

Renders a link or a button to initiate a browse query term lookup. The link opens a new window in which the user can browse to a search term that is guaranteed to return results, using the BrowseResultsElementRenderer. The selected term is then inserted into the initial search form from which the search is executed, using the javascript window.open( ) function and the window.opener property from the pop-up window to pass information.

XML Configuration Template:

  <SearchElementRenderer
     rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.BrowseLinkElementRenderer"
     name         = "[ control name ]"
     action       = "[ page containing the browse results control ]"
     features     = "[ third argument to window.open() ]"
     formName     = "[ form where field exists (DOM path) ]"
     field        = "[ browse field to use for browse lookup WARNING: This field must be in the same form as the browse control ]"
     fieldParam   = "[ url parameter to pass browse field name to browse control for dynamic field linking ]"
     formField    = "[ name of field in local form that field value populates ]"
     cssClass     = "[ cssClass ]"
     text         = "[ text for the button or link ]"
     imageURL     = "[ image for link button ]"
     buttonOrLink = "[ button ]" >

Developed by Raritan Technologies Inc..

Author:: Kepler Gelotte

Field Summary

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

enabled, name

Constructor Summary
`BrowseLinkElementRenderer()`
`BrowseLinkElementRenderer(java.lang.String name, java.lang.String field, java.lang.String formName, java.lang.String action, java.lang.String features)`

Method Summary
`protected java.lang.String`	`doGetBody(ISearchFormRenderer parent, RaritanPageContext pageContext)`
`java.lang.String`	`getAction()`
`java.lang.String`	`getConfigurationXML()`
`void`	`getConfigurationXML(java.io.Writer writer)`
`java.lang.String`	`getCssClass()`
`java.lang.String`	`getFeatures()`
`java.lang.String`	`getFieldID()`
`java.lang.String`	`getFieldParam()`
`java.lang.String`	`getFormName()`
`java.lang.String`	`getImageURL()`
`boolean`	`getIsButton()`
`java.lang.String`	`getText()`
`void`	`initialize(org.w3c.dom.Element elem)` Initialize renderer-specific parameters from the configuration XML tag.
`void`	`setAction(java.lang.String action)`
`void`	`setCssClass(java.lang.String clazz)`
`void`	`setFeatures(java.lang.String features)`
`void`	`setFieldID(java.lang.String field)`
`void`	`setFieldParam(java.lang.String fieldParam)`
`void`	`setFormName(java.lang.String formName)`
`void`	`setImageURL(java.lang.String imageURL)`
`void`	`setIsButton(boolean isButton)`
`void`	`setText(java.lang.String text)`

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