com.raritantechnologies.quickstart.taglibrary
Class PopupFieldResultRenderer

java.lang.Object
  extended bycom.raritantechnologies.quickstart.taglibrary.PopupFieldResultRenderer
All Implemented Interfaces:
IConfigurable, IResultRenderer

public class PopupFieldResultRenderer
extends java.lang.Object
implements IResultRenderer

Creates a fly-over link and a pop-up div. Uses a PatternResultFormatter to create the text for the pop-up div. Clicking on the link causes the pop-up to be displayed, clicking on the pop-up hides it.

XML Configuration Template:
   <ResultRenderer class="com.raritantechnologies.quickstart.taglibrary.PopupFieldResultRenderer" 
                      displayField="[ result field that will be displayed for the fly-over link ]"
                      displayValue="[ alternate fixed value for the pop-up link ]"
                      divIDBase="[ base for div IDs - each renderer will get a unique ID by appending a renderer number to this ]"
                      divStyle="[ css style for pop-up div ]" >

     <PopupPatternFormatter>
       <!-- see PatternResultFormatter for configuration details -->
     </PopupPatternFormatter>

   </ResultRenderer>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
 
Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IResultRenderer
TEMPLATE
 
Constructor Summary
PopupFieldResultRenderer()
           
 
Method Summary
 java.lang.String getConfigurationXML()
           
 java.lang.String getConfigurationXML(java.lang.String configurationTemplate)
           
 IResultRenderer getRenderer(java.lang.String name)
          Provides for nested result renderers.
 void initialize(org.w3c.dom.Element elem)
          IResultRenderers are XML configurable.
 boolean isEnabled()
           
 java.lang.String renderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)
          return an HTML fragment using the data contained within the IResult object.
 void setEnable(boolean enabled)
          provides show/hide control.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PopupFieldResultRenderer

public PopupFieldResultRenderer()
Method Detail

renderResult

public java.lang.String renderResult(IResult result,
                                     int firstResult,
                                     int lastResult,
                                     int resultNum,
                                     RaritanPageContext pageContext)
Description copied from interface: IResultRenderer
return an HTML fragment using the data contained within the IResult object.

Specified by:
renderResult in interface IResultRenderer

initialize

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

Specified by:
initialize in interface IResultRenderer

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

setEnable

public void setEnable(boolean enabled)
Description copied from interface: IResultRenderer
provides show/hide control.

Specified by:
setEnable in interface IResultRenderer

isEnabled

public boolean isEnabled()
Specified by:
isEnabled in interface IResultRenderer

getRenderer

public IResultRenderer getRenderer(java.lang.String name)
Description copied from interface: IResultRenderer
Provides for nested result renderers. returns an instance of IResultRenderer or null if result renderer of given name is not found.

Specified by:
getRenderer in interface IResultRenderer