@DefaultKey(value="form") @ValidScope(value="request") public class FormTool extends Object
View tool to work with HTML forms in Struts.
Struts has support to parse incoming HTTP requests and populate a Java bean with the submitted request parameters. The same Java bean is used to populate forms with initial values. Additionally, a hook allows the application developer to include automatic form validation code.
FormTool provides miscellaneous methods to work with forms and form bean in the context of Struts applications.
Template example(s): <input type="hidden" name="$form.tokenName" value="$form.token"> <input type="submit" name="$form.cancelName" value="Cancel"> Toolbox configuration: <tools> <toolbox scope="request"> <tool class="org.apache.velocity.tools.struts.FormTool"/> </toolbox> </tools>
This tool may only be used in the request scope.
Modifier and Type | Field and Description |
---|---|
protected javax.servlet.http.HttpServletRequest |
request
A reference to the HtttpServletRequest.
|
protected javax.servlet.http.HttpSession |
session
A reference to the HtttpSession.
|
Constructor and Description |
---|
FormTool() |
Modifier and Type | Method and Description |
---|---|
org.apache.struts.action.ActionForm |
getBean()
Returns the form bean associated with this action mapping.
|
String |
getCancelName()
Returns the query parameter name under which a cancel button press
must be reported if form validation is to be skipped.
|
String |
getName()
Returns the form bean name associated with this action mapping.
|
String |
getToken()
Returns the transaction control token for this session or
null if no token exists. |
String |
getTokenName()
Returns the query parameter name under which a transaction token
must be reported.
|
void |
init(Object obj)
Deprecated.
|
void |
setRequest(javax.servlet.http.HttpServletRequest request)
Initializes this tool.
|
protected javax.servlet.http.HttpServletRequest request
protected javax.servlet.http.HttpSession session
@Deprecated public void init(Object obj)
public void setRequest(javax.servlet.http.HttpServletRequest request)
request
- the current HttpServletRequest
IllegalArgumentException
- if the param is not a ViewContextpublic org.apache.struts.action.ActionForm getBean()
Returns the form bean associated with this action mapping.
This is a convenience method. The form bean is automatically available in the Velocity context under the name defined in the Struts configuration.
If the form bean is used repeatedly, it is recommended to create a local variable referencing the bean rather than calling getBean() multiple times.
Example: #set ($defaults = $form.bean) <input type="text" name="username" value="$defaults.username">
ActionForm
associated with this request or
null
if there is no form bean associated with this mappingpublic String getName()
Returns the form bean name associated with this action mapping.
null
if there is no form bean associated with this mappingpublic String getCancelName()
Returns the query parameter name under which a cancel button press must be reported if form validation is to be skipped.
This is the value of
org.apache.struts.taglib.html.Constants.CANCEL_PROPERTY
public String getToken()
null
if no token exists.public String getTokenName()
Returns the query parameter name under which a transaction token
must be reported. This is the value of
org.apache.struts.taglib.html.Constants.TOKEN_KEY
Copyright © 2002–2021 Apache Software Foundation. All rights reserved.