com.raritantechnologies.searchApp.taglibrary
Class SystemObjectSearchElementRenderer

java.lang.Object
  extended bycom.raritantechnologies.searchApp.taglibrary.SystemObjectSearchElementRenderer
All Implemented Interfaces:
IConfigurable, ISearchElementRenderer, ISearchMapModifier

public class SystemObjectSearchElementRenderer
extends java.lang.Object
implements ISearchElementRenderer, ISearchMapModifier

Enables a SearchElementRenderer configuration to be reused by name by storing the reused object in the SystemObject cache.

XML Configuration Template:
   <SearchElementRenderer rendererClass="com.raritantechnologies.searchApp.taglibrary.SystemObjectSearchElementRenderer" 
                             rendererName="[ name of SystemObject of type SearchElementRenderer]"
                             objectFactoryName="[ optional name of configurable object factory ]" />
  

Links to a SearchElementRenderer defined as a global SystemObject:

   <SystemObject type="SearchElementRenderer" name="[name (same as renderername above) ]" 
                    configurableClass="[ class of ISearchElementRenderer ] " >

     <!-- configuration parameters of SearchElementRenderer -->

   </SystemObject>

 
Developed by Raritan Technologies .

Author:
Ted Sullivan

Constructor Summary
SystemObjectSearchElementRenderer()
           
 
Method Summary
 boolean canUpdateSearchParams()
           
 java.lang.String getBody(ISearchFormRenderer parent, RaritanPageContext pageContext)
          Returns the element html fragment.
 ISearchElementRenderer getRenderer(java.lang.String name)
          Returns ISearchElementRenderer of this render or a nested renderer matching the name given or null if no match is found.
 void initialize(org.w3c.dom.Element elem)
          Initialize renderer-specific parameters from the configuration XML tag.
 boolean isHidden(ISearchFormRenderer parent, RaritanPageContext pageContext)
           
 void setEnable(boolean enabled)
          Enable/Disable the renderer.
 void updateSearchParams(RaritanPageContext pageContext, OrderedMap searchParams)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SystemObjectSearchElementRenderer

public SystemObjectSearchElementRenderer()
Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)
Initialize renderer-specific parameters from the configuration XML tag.

Specified by:
initialize in interface ISearchElementRenderer

getBody

public java.lang.String getBody(ISearchFormRenderer parent,
                                RaritanPageContext pageContext)
Returns the element html fragment.

Specified by:
getBody in interface ISearchElementRenderer

setEnable

public void setEnable(boolean enabled)
Enable/Disable the renderer. Disabled renderers are not included in the html output of an ISearchFormRenderer.

Specified by:
setEnable in interface ISearchElementRenderer

isHidden

public boolean isHidden(ISearchFormRenderer parent,
                        RaritanPageContext pageContext)
Specified by:
isHidden in interface ISearchElementRenderer

getRenderer

public ISearchElementRenderer getRenderer(java.lang.String name)
Returns ISearchElementRenderer of this render or a nested renderer matching the name given or null if no match is found.

Specified by:
getRenderer in interface ISearchElementRenderer

canUpdateSearchParams

public boolean canUpdateSearchParams()
Specified by:
canUpdateSearchParams in interface ISearchMapModifier

updateSearchParams

public void updateSearchParams(RaritanPageContext pageContext,
                               OrderedMap searchParams)
Specified by:
updateSearchParams in interface ISearchMapModifier