Class FormTool


  • @DefaultKey("form")
    @ValidScope("request")
    public class FormTool
    extends java.lang.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.

    Since:
    VelocityTools 1.0
    Version:
    $Id: FormTool.java 601976 2007-12-07 03:50:51Z nbubna $
    Author:
    Gabe Sidler
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected HttpServletRequest request
      A reference to the HtttpServletRequest.
      protected HttpSession session
      A reference to the HtttpSession.
    • Constructor Summary

      Constructors 
      Constructor Description
      FormTool()  
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      ActionForm getBean()
      Returns the form bean associated with this action mapping.
      java.lang.String getCancelName()
      Returns the query parameter name under which a cancel button press must be reported if form validation is to be skipped.
      java.lang.String getName()
      Returns the form bean name associated with this action mapping.
      java.lang.String getToken()
      Returns the transaction control token for this session or null if no token exists.
      java.lang.String getTokenName()
      Returns the query parameter name under which a transaction token must be reported.
      void init​(java.lang.Object obj)
      Deprecated.
      void setRequest​(HttpServletRequest request)
      Initializes this tool.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • request

        protected HttpServletRequest request
        A reference to the HtttpServletRequest.
      • session

        protected HttpSession session
        A reference to the HtttpSession.
    • Constructor Detail

      • FormTool

        public FormTool()
    • Method Detail

      • init

        @Deprecated
        public void init​(java.lang.Object obj)
        Deprecated.
      • setRequest

        public void setRequest​(HttpServletRequest request)
        Initializes this tool.
        Parameters:
        request - the current HttpServletRequest
        Throws:
        java.lang.IllegalArgumentException - if the param is not a ViewContext
      • getBean

        public 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">
         
        Returns:
        the ActionForm associated with this request or null if there is no form bean associated with this mapping
      • getName

        public java.lang.String getName()

        Returns the form bean name associated with this action mapping.

        Returns:
        the name of the ActionForm associated with this request or null if there is no form bean associated with this mapping
      • getCancelName

        public java.lang.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

      • getToken

        public java.lang.String getToken()
        Returns the transaction control token for this session or null if no token exists.
      • getTokenName

        public java.lang.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