com.raritantechnologies.searchApp.query.taglibrary
Class SaveQueriesSearchElementRenderer

java.lang.Object
  com.raritantechnologies.searchApp.query.taglibrary.SaveQueriesSearchElementRenderer

All Implemented Interfaces:

IConfigurable, ISearchElementRenderer

public class SaveQueriesSearchElementRenderer

extends java.lang.Object

implements ISearchElementRenderer

Basic SearchElementRenderer that can save the current query to a persistent store.

XML Configuration Template:

  <SearchElementRenderer
     rendererClass="com.raritantechnologies.searchApp.query.taglibrary.SaveQueriesSearchElementRenderer"
     applicationName="[The application name - needed if mixed schema in persistant store]"
     queryWriter="[name of query writer system object (alternate to QueryWriter tag)]"
     queryNameField="[name of query name input in UI]"
     nameFieldSize="[size of input text field]"
     queryButtonText="Save Query"
     queryButtonPos="left|top|bottom|right"
     buttonImage|iconURL="[gif or jpg for button]"
     action="someJsp.jsp"
     extraSubmitParams="[ static parameters to be added to submit href name=value|name=value]"
     requestFields="[ name of field(s) containing request parameters ]" >

    <QueryWriter class="[Implementation class of IQueryResultSetWriter]" >
      <!-- Parameters needed by QueryWriter class -->
    </QueryWriter>

  </SearchElementRenderer>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

SaveQueriesSearchElementRenderer()

Method Summary

java.lang.String	getBody(ISearchFormRenderer parent, RaritanPageContext pageContext) Returns the element html fragment.
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.
void	initialize(org.w3c.dom.Element elem) Initialize renderer-specific parameters from the configuration XML tag.
boolean	isHidden(ISearchFormRenderer parent, RaritanPageContext pageContext)
void	setAction(java.lang.String actionURL)
void	setButtonImage(java.lang.String iconImg)
void	setEnable(boolean enabled) Enable/Disable the renderer.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveQueriesSearchElementRenderer

public SaveQueriesSearchElementRenderer()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: ISearchElementRenderer

Initialize renderer-specific parameters from the configuration XML tag.

Specified by:

initialize in interface ISearchElementRenderer

getBody

public java.lang.String getBody(ISearchFormRenderer parent,
                                RaritanPageContext pageContext)

Description copied from interface: ISearchElementRenderer

Returns the element html fragment.

Specified by:

getBody in interface ISearchElementRenderer

isHidden

public boolean isHidden(ISearchFormRenderer parent,
                        RaritanPageContext pageContext)

Specified by:

isHidden in interface ISearchElementRenderer

setEnable

public void setEnable(boolean enabled)

Description copied from interface: ISearchElementRenderer

Enable/Disable the renderer. Disabled renderers are not included in the html output of an ISearchFormRenderer.

Specified by:

setEnable in interface ISearchElementRenderer

getRenderer

public ISearchElementRenderer getRenderer(java.lang.String name)

Description copied from interface: ISearchElementRenderer

Returns ISearchElementRenderer of this render or a nested renderer matching the name given or null if no match is found.

Specified by:

getRenderer in interface ISearchElementRenderer

setButtonImage

public void setButtonImage(java.lang.String iconImg)

setAction

public void setAction(java.lang.String actionURL)