com.raritantechnologies.quickstart.taglibrary.request
Class RequestFormatTag

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.quickstart.taglibrary.request.RequestFormatTag

All Implemented Interfaces:

IConfigurable, ICustomTag

public class RequestFormatTag

extends BodyTagSupport

implements ICustomTag

JSP Custom tag that renders the current HTTP request using an IRequestFormatter object obtained by name from the SystemObject cache.

JSP Tag Format:

   <request:RequestFormatter name="[ name of the RequestFormatter in the ConfigurationXML ]"
                                activeDisplayParam="[ (optional) name of request parameter to check for activation of formatter ]"
                                activeDisplayKey="[ (optional) value of activeDisplayParam to turn formatting on ]" />
 

This would link to an IRequestFormatter configured as a SystemObject in the application Configuration XML:

   <SystemObjects>

     <SystemObject type="RequestFormatter" name="[ name referenced in the JSP RequestFormatter tag ]"
                      class="[ class of com.raritantechnologies.quickstart.taglibrary.IRequestFormatter ]" >
       <!-- class specific configuration parameters here... -->
     </SystemObject>
   </SystemObjects>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

See Also:

Serialized Form

Field Summary

protected java.lang.String	activeDisplayKey
protected java.lang.String	activeDisplayParam

Constructor Summary

RequestFormatTag()

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	setActiveDisplayKey(java.lang.String displayKey)
void	setActiveDisplayParam(java.lang.String displayParam)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Field Detail

activeDisplayParam

protected java.lang.String activeDisplayParam

activeDisplayKey

protected java.lang.String activeDisplayKey

Constructor Detail

RequestFormatTag

public RequestFormatTag()

Method Detail

setActiveDisplayKey

public void setActiveDisplayKey(java.lang.String displayKey)

setActiveDisplayParam

public void setActiveDisplayParam(java.lang.String displayParam)

setName

public void setName(java.lang.String name)

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