com.raritantechnologies.searchApp.taglibrary
Class SearchElementTag

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.searchApp.taglibrary.SearchElementTag

All Implemented Interfaces:

IConfigurable, ICustomTag

public class SearchElementTag

extends BodyTagSupport

implements ICustomTag

Custom Tag that wraps a single ISearchElementRenderer. Enables a search element such as a InputButtonElement to be placed outside of the SearchForm &t;form> </form> tags.

XML Configuration Template:

   <SystemObject type="CustomTag" name="[ name of this custom tag ]"
                    configurableClass="com.raritantechnologies.searchApp.taglibrary.SearchElementTag"
                    searchFormName="[ name of SearchForm element (defined elsewhere in this configuration) ]"
                    categoryName="[ optional SearchForm category name - required if searchForm has a category attribute ]"
                    rendererName="[ name of SearchElementRenderer element (defined elsewhere in this configuration) ]"
                    useCache="[ true|false(default) - if true, compute output once then reuse ]" >

     <!-- Can define SearchElementRenderer locally ... -->
     <SearchElementRenderer rendererClass="[ class of com.raritantechnologies.searchApp.taglibrary.ISearchElementRenderer ]" >

     </SearchElementRenderer>

   </SystemObject>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

See Also:

Serialized Form

Constructor Summary

SearchElementTag()

Method Summary

int	doStartTag()
java.lang.String	getBody(RaritanPageContext rpc) Returns the tag body.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.util.Map initParams)
void	setCategoryName(java.lang.String categoryName)
void	setRendererName(java.lang.String rendererName)
void	setSearchFormName(java.lang.String searchFormName)
void	setUseCache(java.lang.String useCache)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchElementTag

public SearchElementTag()

Method Detail

setSearchFormName

public void setSearchFormName(java.lang.String searchFormName)

setRendererName

public void setRendererName(java.lang.String rendererName)

setCategoryName

public void setCategoryName(java.lang.String categoryName)

setUseCache

public void setUseCache(java.lang.String useCache)

doStartTag

public int doStartTag()
               throws JspException

Throws:

JspException

getBody

public java.lang.String getBody(RaritanPageContext rpc)

Description copied from interface: ICustomTag

Returns the tag body.

Specified by:

getBody in interface ICustomTag

Parameters:

rpc - Platform-neutral page context ( can be used in non J2EE environments such as ASP).

Returns:

The tag body text string.

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

initialize

public void initialize(java.util.Map initParams)

Specified by:

initialize in interface ICustomTag