com.raritantechnologies.searchApp.taglibrary
Class SearchFormGridRenderer

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

public class SearchFormGridRenderer
extends BasicSearchElementRenderer

Renders a grid of ISearchElementRenderers. The contents of each cell are either static SearchElementRenderers or are generated at runtime using a SearchElementRenderers that implement the ISelector interface to generate a list of renderers based on the current state. Currently cells are filled up left to right, top to bottom.

XML Configuration Template:
   <SearchElementRenderer
                  rendererClass="com.raritantechnologies.searchApp.taglibrary.SearchFormGridRenderer"
                  columns="[ number of columns in table]"
                  tableProps="[ set of table properties added to table tag]" 
                  halign="[horizontal alignment: left|right|center" 
                  valign="[vertical alignment: top|bottom|center" >

     <SearchElementRenderer rendererClass="[class of com.raritantechnologies.searchApp.taglibrary.ISearchElementRenderer]" >

     </SearchElementRenderer>

     <!-- SearchElementRenderer that implements ISelector -->
     <SearchElementRenderer rendererClass="[ class of com.raritantechnologies.searchApp.taglibrary.ISearchElementRenderer
                                                AND class of com.raritantechnologies.searchApp.selectors.ISelector ]" >
      <Option name="[ value of that will cause the contained renderers to be selected]" >
        <SearchElementRenderer rendererClass="[ class of SearchElementRenderer ]" >
        </SearchElementRenderer>

        </SearchElementRenderer rendererClass="[ class of SearchElementRenderer ]" >
        </SearchElementRenderer>
      </Option>
     </SearchElementRenderer>

   </SearchForm>
 

Developed by Raritan Technologies .

Author:
Keith Coulson

Field Summary
 
Fields inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchElementRenderer
enabled, name
 
Constructor Summary
SearchFormGridRenderer()
           
 
Method Summary
 void addRenderer(org.w3c.dom.Element rendererElement)
           
protected  java.lang.String doGetBody(ISearchFormRenderer parent, RaritanPageContext pageContext)
           
 int getColumns()
           
 java.lang.String getConfigurationXML()
           
 java.lang.String getHAlignment()
           
 int getIntAttribute(org.w3c.dom.Element element, java.lang.String attributeName)
          Utility function to extract an int attribute from a node
 int getMaxRender()
           
 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.
 java.lang.String getStringAttribute(org.w3c.dom.Element element, java.lang.String attributeName)
          extract a string attribute from a node
 java.lang.String getTableProps()
           
 java.lang.String getVAlignment()
           
 java.lang.String getWidth()
           
 void initialize(org.w3c.dom.Element element)
          Initialize renderer-specific parameters from the configuration XML tag.
 void setChildRenderers(ISearchElementRenderer[] renderers)
           
 void setColumns(int columns)
           
 void setHAlignment(java.lang.String halign)
           
 void setMaxRender(int maxRender)
           
 void setTableProps(java.lang.String tableProps)
           
 void setVAlignment(java.lang.String valign)
           
 void setWidth(java.lang.String width)
           
 
Methods inherited from class com.raritantechnologies.searchApp.taglibrary.BasicSearchElementRenderer
doGetBodyDisabled, getBody, getInitValue, getInitValue, getInitValue, isHidden, setEnable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchFormGridRenderer

public SearchFormGridRenderer()
Method Detail

initialize

public void initialize(org.w3c.dom.Element element)
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

getStringAttribute

public java.lang.String getStringAttribute(org.w3c.dom.Element element,
                                           java.lang.String attributeName)
extract a string attribute from a node


getIntAttribute

public int getIntAttribute(org.w3c.dom.Element element,
                           java.lang.String attributeName)
Utility function to extract an int attribute from a node


getRenderer

public ISearchElementRenderer getRenderer(java.lang.String name)
Description copied from interface: ISearchElementRenderer
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
Overrides:
getRenderer in class BasicSearchElementRenderer

addRenderer

public void addRenderer(org.w3c.dom.Element rendererElement)

doGetBody

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

setChildRenderers

public void setChildRenderers(ISearchElementRenderer[] renderers)

setMaxRender

public void setMaxRender(int maxRender)

getMaxRender

public int getMaxRender()

setColumns

public void setColumns(int columns)

getColumns

public int getColumns()

setWidth

public void setWidth(java.lang.String width)

getWidth

public java.lang.String getWidth()

setTableProps

public void setTableProps(java.lang.String tableProps)

getTableProps

public java.lang.String getTableProps()

setHAlignment

public void setHAlignment(java.lang.String halign)

getHAlignment

public java.lang.String getHAlignment()

setVAlignment

public void setVAlignment(java.lang.String valign)

getVAlignment

public java.lang.String getVAlignment()

getConfigurationXML

public java.lang.String getConfigurationXML()