com.raritantechnologies.searchApp.taglibrary
Class DisplayControlTag

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

All Implemented Interfaces:

IConfigurable, ICustomTag, IDisplayFormRenderer

public class DisplayControlTag

extends BodyTagSupport

implements ICustomTag, IDisplayFormRenderer

Standalone JSP Custom tag for IDisplayControlRenderers. The nested IDisplayControlRenderer can be identified by name, in which case the DisplayControlTag will look for a SystemObject tag of type "DisplayControlRenderer". Alternatively, the DisplayControlRenderer can be initialized using an implementation class name and a set of parameters.

JSP Custom Tag Template:

   This version connects to a <DisplayControlRenderer SystemObject tag:
   <results:DisplayControlForm displayFormName="[ associated display form for control ]"
                                  displayControlName="[ name of display control as defined in configuration XML ]" />

   This version directly specifies a Java IDisplayControlRenderer class and its initialiation parameters:
   <results:DisplayControlForm displayFormName="[ associated display form for control ]"
                                  displayControlClass="[ alternatively - set java class to use ]"
                                  controlParameters="[ param=value|param2=value2 ]" />

   This version directly specifies a Java IDisplayControlRenderer class and its initialiation parameters and
   the field and value delimiters to use:
   <results:DisplayControlForm displayFormName="[ associated display form for control ]"
                                  displayControlClass="[ alternatively - set java class to use ]"
                                  controlParameters="[ param:value;param2:value2 ]"
                                  fieldDelimiter=";"
                                  valueDelimiter=":" />
  
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

See Also:

Serialized Form

Field Summary

protected java.lang.String	categoryParam
protected java.lang.String	sourceTypeParam

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

TEMPLATE

Constructor Summary

DisplayControlTag()

Method Summary

void	addBodyTrailerContent(java.lang.String content) Add html content to be appended to the body of the displayFormRenderer
void	disableRenderers(java.util.HashSet disabledRenderers)
int	doStartTag()
void	enableRenderers(java.util.HashSet enabledRenderers)
java.lang.String	getBody(IResultSet resultSet, java.lang.String displayFormName, RaritanPageContext pageContext) Returns the display form body as an HTML fragment, by formatting the data contained in an IResultSet.
java.lang.String	getBody(RaritanPageContext rpc) Returns the tag body.
IResultRenderer	getResultRenderer(java.lang.String name)
protected java.lang.String	getSourceCategory(RaritanPageContext rPageContext)
protected java.lang.String	getSourceType(RaritanPageContext rPageContext)
void	initialize(org.w3c.dom.Element elem) Initialize the search form renderer from the configuration XML.
void	initialize(java.util.Map initParams)
void	setControlParameters(java.lang.String displayControlParameters)
void	setDisabledRendererParam(java.lang.String disabledParam)
void	setDisplayControlClass(java.lang.String displayControlClass)
void	setDisplayControlName(java.lang.String displayControlName)
void	setDisplayFormName(java.lang.String displayFormName)
void	setEnabledRendererParam(java.lang.String enabledParam)
void	setEnabledRenderers(java.lang.String displayForm, RaritanPageContext pageContext)
void	setFieldDelimiter(java.lang.String fieldDelimiter)
void	setValueDelimiter(java.lang.String valueDelimiter)

Methods inherited from class java.lang.Object

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

Field Detail

categoryParam

protected java.lang.String categoryParam

sourceTypeParam

protected java.lang.String sourceTypeParam

Constructor Detail

DisplayControlTag

public DisplayControlTag()

Method Detail

setDisplayFormName

public void setDisplayFormName(java.lang.String displayFormName)

setDisplayControlName

public void setDisplayControlName(java.lang.String displayControlName)

setDisplayControlClass

public void setDisplayControlClass(java.lang.String displayControlClass)

setControlParameters

public void setControlParameters(java.lang.String displayControlParameters)

setFieldDelimiter

public void setFieldDelimiter(java.lang.String fieldDelimiter)

setValueDelimiter

public void setValueDelimiter(java.lang.String valueDelimiter)

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.

getBody

public java.lang.String getBody(IResultSet resultSet,
                                java.lang.String displayFormName,
                                RaritanPageContext pageContext)

Returns the display form body as an HTML fragment, by formatting the data contained in an IResultSet.

Specified by:

getBody in interface IDisplayFormRenderer

addBodyTrailerContent

public void addBodyTrailerContent(java.lang.String content)

Add html content to be appended to the body of the displayFormRenderer

Specified by:

addBodyTrailerContent in interface IDisplayFormRenderer

getResultRenderer

public IResultRenderer getResultRenderer(java.lang.String name)

Specified by:

getResultRenderer in interface IDisplayFormRenderer

setEnabledRendererParam

public void setEnabledRendererParam(java.lang.String enabledParam)

Specified by:

setEnabledRendererParam in interface IDisplayFormRenderer

setDisabledRendererParam

public void setDisabledRendererParam(java.lang.String disabledParam)

Specified by:

setDisabledRendererParam in interface IDisplayFormRenderer

setEnabledRenderers

public void setEnabledRenderers(java.lang.String displayForm,
                                RaritanPageContext pageContext)

Specified by:

setEnabledRenderers in interface IDisplayFormRenderer

enableRenderers

public void enableRenderers(java.util.HashSet enabledRenderers)

Specified by:

enableRenderers in interface IDisplayFormRenderer

disableRenderers

public void disableRenderers(java.util.HashSet disabledRenderers)

Specified by:

disableRenderers in interface IDisplayFormRenderer

getSourceCategory

protected java.lang.String getSourceCategory(RaritanPageContext rPageContext)

getSourceType

protected java.lang.String getSourceType(RaritanPageContext rPageContext)

initialize

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

Description copied from interface: IDisplayFormRenderer

Initialize the search form renderer from the configuration XML.

Specified by:

initialize in interface IConfigurable

initialize

public void initialize(java.util.Map initParams)

Specified by:

initialize in interface ICustomTag