com.raritantechnologies.quickstart.taglibrary
Class ReadOnlyElement

java.lang.Object
  extended bycom.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      extended bycom.raritantechnologies.quickstart.taglibrary.ReadOnlyElement
All Implemented Interfaces:
IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class ReadOnlyElement
extends BasicResultRenderer
implements IResultRenderer

Renders an field value as a label or as an HTML comment.

XML Configuration Template:
  <SearchElementRenderer
     rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.ReadOnlyElement"
     field="name of field or sessionData parameter"
     label="text before the text or comment"
     labelWithNoData="true" Label displayed when there are no values?
     multiRow="false"  Should individual values be on separate lines? (text only)
     delimiter=","     For use with multiRow only
     class="cssClass"
     textOrComment="text" />
 

Developed by Raritan Technologies Inc..

Author:
Kepler Gelotte

Field Summary
 
Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
enabled, name, prefBeanName, prefCompareValue, prefEnableIfInChecklist, prefEnableIfInYesno
 
Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer
TEMPLATE
 
Constructor Summary
ReadOnlyElement()
           
 
Method Summary
protected  java.lang.String doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)
           
 java.lang.String getConfigurationXML()
           
 java.lang.String getConfigurationXML(java.lang.String configurationTemplate)
           
 void getConfigurationXML(java.io.Writer writer)
           
 java.lang.String getCssClass()
           
 java.lang.String getDelimiter()
           
 java.lang.String getFieldID()
           
 boolean getIsMultiRow()
           
 boolean getIsText()
           
 java.lang.String getLabel()
           
 boolean getLabelWithNoData()
           
 void initialize(org.w3c.dom.Element elem)
          IResultRenderers are XML configurable.
 void setCssClass(java.lang.String clazz)
           
 void setDelimiter(java.lang.String delimiter)
           
 void setFieldID(java.lang.String field)
           
 void setIsMultiRow(boolean isMultiRow)
           
 void setIsText(boolean isText)
           
 void setLabel(java.lang.String label)
           
 void setLabelWithNoData(boolean labelWithNoData)
           
 
Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
getPrefBeanName, getPrefCompareValue, getPrefEnableIfInChecklist, getPrefEnableIfInYesno, getRenderer, isEnabled, renderResult, setEnable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer
getRenderer, isEnabled, renderResult, setEnable
 

Constructor Detail

ReadOnlyElement

public ReadOnlyElement()
Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)
Description copied from interface: IResultRenderer
IResultRenderers are XML configurable.

Specified by:
initialize in interface IResultRenderer
Overrides:
initialize in class BasicResultRenderer

doRenderResult

protected java.lang.String doRenderResult(IResult result,
                                          int firstResult,
                                          int lastResult,
                                          int resultNum,
                                          RaritanPageContext pageContext)
Specified by:
doRenderResult in class BasicResultRenderer

setFieldID

public void setFieldID(java.lang.String field)

getFieldID

public java.lang.String getFieldID()

setLabel

public void setLabel(java.lang.String label)

getLabel

public java.lang.String getLabel()

setCssClass

public void setCssClass(java.lang.String clazz)

getCssClass

public java.lang.String getCssClass()

setDelimiter

public void setDelimiter(java.lang.String delimiter)

getDelimiter

public java.lang.String getDelimiter()

setIsText

public void setIsText(boolean isText)

getIsText

public boolean getIsText()

setIsMultiRow

public void setIsMultiRow(boolean isMultiRow)

getIsMultiRow

public boolean getIsMultiRow()

setLabelWithNoData

public void setLabelWithNoData(boolean labelWithNoData)

getLabelWithNoData

public boolean getLabelWithNoData()

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException
Throws:
java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()
Specified by:
getConfigurationXML in interface IResultRenderer

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)
Specified by:
getConfigurationXML in interface IResultRenderer