com.raritantechnologies.quickstart.taglibrary.forms
Class TextAreaElementRenderer

java.lang.Object
  extended bycom.raritantechnologies.searchApp.taglibrary.BasicSearchElementRenderer
      extended bycom.raritantechnologies.quickstart.taglibrary.forms.TextAreaElementRenderer
All Implemented Interfaces:
IConfigurable, ISearchElementRenderer

public class TextAreaElementRenderer
extends BasicSearchElementRenderer

Renders a query input field as an HTML TextArea within a SearchForm.

Can be configured to initialize the text area field from the HTTP request, the last submitted query, or from the session cache.

May contain an optional IStringFilter to modify any initial string value before rendering the input box.

XML Configuration Template:
  <SearchElementRenderer 
     rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.TextAreaElementRenderer"
     isPopup="[ 'true' if are rendered from PopupLinkElementRenderer otherwise 'false' ]"    
     reloadOnExit="false"   for popups only
     fieldID="theFieldID" 
     rows="50" 
     cols="80" 
     initClear="true"
     attributes="[ attributes to the textarea ex: style='height:100%;width:100%;' ]"   
     initFrom="request|lastQuery|searchSource"
     clearRequest="sourceType=clear" >

    <InputFilter class="[IStringFilter implementation]" >
      <!-- InputFilter parameters -->
    </InputFilter>

    <!-- optional InitFromControl to provide context-dependent control of refresh: -->
    <InitFromControl requestParam="formType" defaultValue="[request|lastQuery|searchSource]" >
      <Request value="[ formType value or 'null' ]"  initFrom="[ one of request|lastQuery|searchSource]" />
    </InitFromControl>

    <SearchSource name="[searchSource name]" delimiter="," >

       <!-- One or more SearchField elements: -->
       <SearchField requestField="[fieldID]" sourceField="[ field in source ]" />
       <!-- etc. . . -->

       <!-- One or more ResultField elements: -->
       <ResultField ID="[ result field to get form input value ]" />
       <!-- etc. . . -->

    </SearchSource>

   </SearchElementRenderer>

  

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
 
Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchElementRenderer
enabled, name
 
Constructor Summary
TextAreaElementRenderer()
           
 
Method Summary
protected  java.lang.String doGetBody(ISearchFormRenderer parent, RaritanPageContext pageContext)
           
 java.lang.String getAttributes()
           
 boolean getClearField()
           
 java.lang.String getClearRequest()
           
 java.lang.String getCols()
           
 java.lang.String getConfigurationXML()
           
 java.lang.String getFieldID()
           
 java.lang.String getInitFrom()
           
 boolean getIsPopup()
           
 boolean getReloadOnExit()
           
 java.lang.String getRows()
           
 IStringFilter getStringFilter()
           
 void initialize(org.w3c.dom.Element elem)
          Initialize renderer-specific parameters from the configuration XML tag.
 void setAttributes(java.lang.String attributes)
           
 void setClearField(boolean clearField)
           
 void setClearRequest(java.lang.String clearRequest)
           
 void setCols(java.lang.String cols)
           
 void setFieldID(java.lang.String fieldID)
           
 void setInitFrom(java.lang.String initFrom)
           
 void setIsPopup(boolean isPopup)
           
 void setReloadOnExit(boolean reloadOnExit)
           
 void setRows(java.lang.String rows)
           
 void setStringFilter(IStringFilter theFilter)
           
 
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

TextAreaElementRenderer

public TextAreaElementRenderer()
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
Overrides:
initialize in class BasicSearchElementRenderer

doGetBody

protected java.lang.String doGetBody(ISearchFormRenderer parent,
                                     RaritanPageContext pageContext)
Specified by:
doGetBody in class BasicSearchElementRenderer

setFieldID

public void setFieldID(java.lang.String fieldID)

getFieldID

public java.lang.String getFieldID()

setAttributes

public void setAttributes(java.lang.String attributes)

getAttributes

public java.lang.String getAttributes()

setRows

public void setRows(java.lang.String rows)

getRows

public java.lang.String getRows()

setCols

public void setCols(java.lang.String cols)

getCols

public java.lang.String getCols()

setInitFrom

public void setInitFrom(java.lang.String initFrom)

getInitFrom

public java.lang.String getInitFrom()

setIsPopup

public void setIsPopup(boolean isPopup)

getIsPopup

public boolean getIsPopup()

setReloadOnExit

public void setReloadOnExit(boolean reloadOnExit)

getReloadOnExit

public boolean getReloadOnExit()

setClearField

public void setClearField(boolean clearField)

getClearField

public boolean getClearField()

setClearRequest

public void setClearRequest(java.lang.String clearRequest)

getClearRequest

public java.lang.String getClearRequest()

setStringFilter

public void setStringFilter(IStringFilter theFilter)

getStringFilter

public IStringFilter getStringFilter()

getConfigurationXML

public java.lang.String getConfigurationXML()