com.raritantechnologies.searchApp.taglibrary
Class PanelDisplayFormRenderer

java.lang.Object
  extended bycom.raritantechnologies.searchApp.taglibrary.PanelDisplayFormRenderer
All Implemented Interfaces:
IConfigurable, IDisplayFormRenderer

public class PanelDisplayFormRenderer
extends java.lang.Object
implements IDisplayFormRenderer

Panel display table. This control allows selecting/deselecting from a list of results. Saves the results concatenated as a delimited list of values.

NOTE: This renderer is typically called from a com.raritantechnologies.quickstart.forms.PopupLinkElementRenderer and is renderered in a separate popup window.

XML Configuration Template:
  <DisplayForm name="brief"
      rendererClass="com.raritantechnologies.searchApp.taglibrary.PanelDisplayFormRenderer"
      field="[ field from the search source ]"
      outputField="[ persistent parameter where selected values will end up ]"
      delimiter=", - The delimiter for multiple values "   
      tableProps="[ properties for containing table ]"
      cssClass="[ css class for the select elements ]"
      selectedText="Use Selected Values"
      cancelText="Cancel"
      addText=">>>"
      removeText="<<<"
      selectedImage="images/selected.gif"
      cancelImage="images/cancel.gif"
      buttonOrImage="button"
      reloadOnExit="false"	// if true causes a reload of calling page
      rows="number of rows in select lists" >
  </DisplayForm>
 

Developed by Raritan Technologies .

Author:
Kepler Gelotte

Field Summary
 
Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer
TEMPLATE
 
Constructor Summary
PanelDisplayFormRenderer()
           
 
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)
           
 void enableRenderers(java.util.HashSet enabledRenderers)
           
 java.lang.String getActionType()
           
 java.lang.String getAddText()
           
 java.lang.String getBody(IResultSet theResults, java.lang.String displayFormName, RaritanPageContext pageContext)
          returns the HTML Panel fragment for the given set of results.
 java.lang.String getCancelImage()
           
 java.lang.String getCancelText()
           
 java.lang.String getConfigurationXML()
           
 java.lang.String getCssClass()
           
 java.lang.String getDelimiter()
           
 java.lang.String getFieldID()
           
 java.lang.String getFromLabel()
           
 boolean getIsImage()
           
 java.lang.String getOutputField()
           
 boolean getReloadOnExit()
           
 java.lang.String getRemoveText()
           
 IResultRenderer getResultRenderer(java.lang.String name)
           
 int getRows()
           
 java.lang.String getSelectedImage()
           
 java.lang.String getSelectedText()
           
 java.lang.String getTableProps()
           
 java.lang.String getToLabel()
           
 java.lang.String getTrailer()
           
 void initialize(org.w3c.dom.Element elem)
          Initialize the display form renderer from the configuration XML.
 void initialize(java.util.Map renderParams)
          Initialize the display form renderer from a set of configuration parameters.
 void setActionType(java.lang.String actionType)
           
 void setAddText(java.lang.String addText)
           
 void setCancelImage(java.lang.String cancelImage)
           
 void setCancelText(java.lang.String cancelText)
           
 void setCssClass(java.lang.String clazz)
           
 void setDelimiter(java.lang.String delimiter)
           
 void setDisabledRendererParam(java.lang.String disabledParam)
           
 void setEnabledRendererParam(java.lang.String enabledParam)
           
 void setEnabledRenderers(java.lang.String displayForm, RaritanPageContext pageContext)
           
 void setFieldID(java.lang.String fieldID)
           
 void setFromLabel(java.lang.String fromLabel)
           
 void setIsImage(boolean isImage)
           
 void setOutputField(java.lang.String outputField)
           
 void setReloadOnExit(boolean reloadOnExit)
           
 void setRemoveText(java.lang.String removeText)
           
 void setRows(int rows)
           
 void setSelectedImage(java.lang.String selectedImage)
           
 void setSelectedText(java.lang.String selectedText)
           
 void setTableProps(java.lang.String tableProps)
           
 void setToLabel(java.lang.String toLabel)
           
 void setTrailer(java.lang.String trailer)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PanelDisplayFormRenderer

public PanelDisplayFormRenderer()
Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)
Initialize the display form renderer from the configuration XML.

Specified by:
initialize in interface IDisplayFormRenderer

initialize

public void initialize(java.util.Map renderParams)
Initialize the display form renderer from a set of configuration parameters.


getBody

public java.lang.String getBody(IResultSet theResults,
                                java.lang.String displayFormName,
                                RaritanPageContext pageContext)
returns the HTML Panel fragment for the given set of results.

Specified by:
getBody in interface IDisplayFormRenderer

getResultRenderer

public IResultRenderer getResultRenderer(java.lang.String name)
Specified by:
getResultRenderer in interface IDisplayFormRenderer

addBodyTrailerContent

public void addBodyTrailerContent(java.lang.String content)
Description copied from interface: IDisplayFormRenderer
Add html content to be appended to the body of the displayFormRenderer

Specified by:
addBodyTrailerContent 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

setActionType

public void setActionType(java.lang.String actionType)

getActionType

public java.lang.String getActionType()

setFieldID

public void setFieldID(java.lang.String fieldID)

getFieldID

public java.lang.String getFieldID()

setOutputField

public void setOutputField(java.lang.String outputField)

getOutputField

public java.lang.String getOutputField()

setFromLabel

public void setFromLabel(java.lang.String fromLabel)

getFromLabel

public java.lang.String getFromLabel()

setToLabel

public void setToLabel(java.lang.String toLabel)

getToLabel

public java.lang.String getToLabel()

setTableProps

public void setTableProps(java.lang.String tableProps)

getTableProps

public java.lang.String getTableProps()

setDelimiter

public void setDelimiter(java.lang.String delimiter)

getDelimiter

public java.lang.String getDelimiter()

setTrailer

public void setTrailer(java.lang.String trailer)

getTrailer

public java.lang.String getTrailer()

setCssClass

public void setCssClass(java.lang.String clazz)

getCssClass

public java.lang.String getCssClass()

setRows

public void setRows(int rows)

getRows

public int getRows()

setIsImage

public void setIsImage(boolean isImage)

getIsImage

public boolean getIsImage()

setSelectedImage

public void setSelectedImage(java.lang.String selectedImage)

getSelectedImage

public java.lang.String getSelectedImage()

setCancelImage

public void setCancelImage(java.lang.String cancelImage)

getCancelImage

public java.lang.String getCancelImage()

setSelectedText

public void setSelectedText(java.lang.String selectedText)

getSelectedText

public java.lang.String getSelectedText()

setCancelText

public void setCancelText(java.lang.String cancelText)

getCancelText

public java.lang.String getCancelText()

setAddText

public void setAddText(java.lang.String addText)

getAddText

public java.lang.String getAddText()

setRemoveText

public void setRemoveText(java.lang.String removeText)

getRemoveText

public java.lang.String getRemoveText()

setReloadOnExit

public void setReloadOnExit(boolean reloadOnExit)

getReloadOnExit

public boolean getReloadOnExit()

getConfigurationXML

public java.lang.String getConfigurationXML()