com.raritantechnologies.quickstart.taglibrary.forms
Class InputButtonElement

java.lang.Object
  extended bycom.raritantechnologies.quickstart.taglibrary.forms.InputButtonElement
All Implemented Interfaces:
IConfigurable, ISearchElementRenderer

public class InputButtonElement
extends java.lang.Object
implements ISearchElementRenderer

Renders a form input button. Coordinates javascript onSubmit or image-based input buttons.

Writes a input button tag of a SearchForm from data stored in an ISessionDataManager

XML Configuration Template:
 <SearchElementRenderer
      rendererClass="com.raritantechnologies.quickstart.taglibrary.forms.InputButtonElement"
      cssClass="[ cssClass ]"
      text="Do It!"
      name="[ button name ]"
      iconURL="[ url of icon image ]"
      onClick="[ onClick function ]"
      renderAsHyperlink="true|false(default)"
      activeOn="sessionData|request:[param=value|NOT NULL]"
      clickTarget="[ url of onClick target (alternate to onClick function ) ]"
      requestParams="[ comma separated list of request parameters for clickTarget ]" > 

   <SubmitHandler>
     <!-- javascript handler function -->
   </SubmitHandler>

 </SearchElementRenderer>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Constructor Summary
InputButtonElement()
           
 
Method Summary
 java.lang.String getBody(ISearchFormRenderer parent, RaritanPageContext pageContext)
          Returns the element html fragment.
 java.lang.String getConfigurationXML()
           
 void getConfigurationXML(java.io.Writer writer)
           
 java.lang.String getCssClass()
           
 java.lang.String getIconURL()
           
 java.lang.String getName()
           
 java.lang.String getOnClick()
           
 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 getSubmitHandler()
           
 java.lang.String getText()
           
 void initialize(org.w3c.dom.Element elem)
          Initialize renderer-specific parameters from the configuration XML tag.
 boolean isHidden(ISearchFormRenderer parent, RaritanPageContext pageContext)
           
 void setButtonIcon(java.lang.String buttonIconURL)
           
 void setCssClass(java.lang.String cssClass)
           
 void setEnable(boolean enabled)
          Enable/Disable the renderer.
 void setIconURL(java.lang.String iconURL)
           
 void setName(java.lang.String name)
           
 void setOnClick(java.lang.String onClick)
           
 void setSubmitHandler(java.lang.String onSubmitHandler)
           
 void setText(java.lang.String text)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InputButtonElement

public InputButtonElement()
Method Detail

setButtonIcon

public void setButtonIcon(java.lang.String buttonIconURL)

initialize

public void initialize(org.w3c.dom.Element elem)
Description copied from interface: ISearchElementRenderer
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)
Description copied from interface: ISearchElementRenderer
Returns the element html fragment.

Specified by:
getBody in interface ISearchElementRenderer

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

setEnable

public void setEnable(boolean enabled)
Description copied from interface: ISearchElementRenderer
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

setIconURL

public void setIconURL(java.lang.String iconURL)

getIconURL

public java.lang.String getIconURL()

setText

public void setText(java.lang.String text)

getText

public java.lang.String getText()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setOnClick

public void setOnClick(java.lang.String onClick)

getOnClick

public java.lang.String getOnClick()

setCssClass

public void setCssClass(java.lang.String cssClass)

getCssClass

public java.lang.String getCssClass()

setSubmitHandler

public void setSubmitHandler(java.lang.String onSubmitHandler)

getSubmitHandler

public java.lang.String getSubmitHandler()

getConfigurationXML

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

getConfigurationXML

public java.lang.String getConfigurationXML()