|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.ObjectBodyTagSupport
com.raritantechnologies.quickstart.taglibrary.PageResetButton
Resets a page by sending a request with default values for elements that should be reset. Can also include commands such as searchType="clear" for elements that do not get their context from the page request.
Sets all configured parameters to default values.
XML Configuration Template:
<SearchElementRenderer
rendererClass="com.raritantechnologies.quickstart.taglibrary.PageResetButton"
buttonImage|iconURL="./images/buttonIcon.gif"
buttonText="[alternate to image]"
functionName="resetPage" >
<Params>
<Param name="[the req param]" reset="" />
<Param name="[another param]" reset="true" />
<Param name="[a command param]" reset="clear" />
</Params>
</SearchElementRenderer>
Custom tag syntax:
<search:PageResetButton resetParams="reqparam=val|reqParam2=val2|etc. etc." buttonImage="./images/buttonIcon.gif" buttonText="[alternative to image button]" functionName="resetPage" />
| Constructor Summary | |
PageResetButton()
|
|
| Method Summary | |
int |
doStartTag()
|
java.lang.String |
getBody(ISearchFormRenderer parent,
RaritanPageContext pageContext)
Returns the element html fragment. |
java.lang.String |
getBody(RaritanPageContext pageContext)
Returns the tag body. |
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. |
void |
initialize(java.util.Map initParams)
|
boolean |
isHidden(ISearchFormRenderer parent,
RaritanPageContext pageContext)
|
void |
setButtonImage(java.lang.String iconImg)
|
void |
setButtonText(java.lang.String buttonText)
|
void |
setEnable(boolean enabled)
Enable/Disable the renderer. |
void |
setFunctionName(java.lang.String resetFunction)
|
void |
setResetParams(java.lang.String paramList)
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public PageResetButton()
| Method Detail |
public void setResetParams(java.lang.String paramList)
public void setButtonImage(java.lang.String iconImg)
public void setButtonText(java.lang.String buttonText)
public void setFunctionName(java.lang.String resetFunction)
public void initialize(org.w3c.dom.Element elem)
ISearchElementRenderer
initialize in interface IConfigurablepublic void initialize(java.util.Map initParams)
initialize in interface ICustomTag
public int doStartTag()
throws JspException
JspException
public java.lang.String getBody(ISearchFormRenderer parent,
RaritanPageContext pageContext)
ISearchElementRenderer
getBody in interface ISearchElementRendererpublic java.lang.String getBody(RaritanPageContext pageContext)
ICustomTag
getBody in interface ICustomTagpageContext - Platform-neutral page context ( can be used in non J2EE environments such as ASP).
public ISearchElementRenderer getRenderer(java.lang.String name)
ISearchElementRenderer
getRenderer in interface ISearchElementRenderer
public boolean isHidden(ISearchFormRenderer parent,
RaritanPageContext pageContext)
isHidden in interface ISearchElementRendererpublic void setEnable(boolean enabled)
ISearchElementRenderer
setEnable in interface ISearchElementRenderer
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||