org.javalite.activeweb.freemarker

Class FormTag

java.lang.Object

org.javalite.activeweb.freemarker.FreeMarkerTag

org.javalite.activeweb.freemarker.FormTag

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

public class FormTag
extends FreeMarkerTag

This is a FreeMarker directive which is registered as <@form... /> tag. This tag generates an HTML form tag and has functionality specific for ActiveWeb. Like any other ActiveWeb tag, it has ability to pass through any non - ActiveWeb attributes. This means that if you specify any attribute that is not mentioned here, it will be passed through as a regular HTML attribute.

Attributes:

• controller - name of a controller to post this form to. Optional. If this attribute is not provided, the tag will find a current controller in context which was used to generate a data for the current view and uses it. It makes it convenient to write many views for the same controller.
• action - name of an action to post this form to.This is different from regular HTML form@action attribute, as controller, action and id attributes will be used to form an appropriate HTML form action value. Optional.
• id - value of URI "id". Used as URI "id" in forming an HTML Form action attribute, such as: <form action="controller/action/id". Do not confuse with HTML element ID. Optional.
• html_id - value of HTML Form element ID, as in <form id="123...". Optoinal.
• method - this is an HTTP method. Allowed values: GET (default), POST, PUT, DELETE. In case, the values are "put" or "delete", additional hidden input names "_method" will be generated, and the actual HTML method will be set to "post". This workaround is necessary because browsers still do not support PUT and DELETE. Optional.

This tag also is REST-aware, and will generate appropriate formats for HTML Form tag action value depending if the controller is RESTful or not, see RESTful for more information.

Examples (given that the current context is "simple_context"):

Simple form

code:

 <@form controller="simple" action="index" method="get"/>
 

will generate this HMTL:

 <form action="/simple_context/simple/index" method="get"/>
 

POST form with ID

code:

 <@form controller="simple" action="index" id="123" method="post" html_id="formA"/>
 

will generate:

 <form action="/simple_context/simple/index/123" method="post" id="formA"/>

Put form

code:

  <@form controller="simple" action="index" method="put">
       <input type="hidden" name="blah">
  </@form>
 

will generate this HMTL:

 <form action="/simple_context/simple/index" method="post">
       <input type='hidden' name='_method' value='put' />
       <input type="hidden" name="blah">
 </form>
 

Put form for RESTful controller

code:

<@form controller="photos"  id="x123" method="put" html_id="formA">
       <input type="hidden" name="blah">
 </@form>

will generate:

  <form action="/simple_context/photos/x123" method="post" id="formA">
       <input type='hidden' name='_method' value='put' />
       <input type="hidden" name="blah">
  </form>
 

Adding HTML5-style attributes

Use a special attribute "data", whose value will be added to the resulting tag verbatim.

 <@form data="data-greeting='hola' data-bye='astalavista'" ...  >

Author:

Igor Polevoy

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
FormTag()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	render(Map params, String body, Writer writer) Implement this method ina concrete subclass.

Methods inherited from class org.javalite.activeweb.freemarker.FreeMarkerTag

appContext, context, cookie, cookies, cookieValue, execute, exists, format, get, getAllVariables, getContextPath, getId, getLocale, getRequestHost, getRequestPort, getRequestProtocol, getRoute, getUnwrapped, getUnwrapped, header, headers, host, ipAddress, ipForwardedFor, isDelete, isGet, isHead, isMethod, isPost, isPut, isXhr, locale, logger, method, overrideContext, param, params, params, params1st, path, port, process, protocol, queryString, remoteAddress, remoteHost, requestHas, session, session, sessionObject, uri, url, userAgent, validateParamsPresence, xhr

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormTag

public FormTag()

Method Detail

render

protected void render(Map params,
          String body,
          Writer writer)
               throws Exception

Description copied from class: FreeMarkerTag

Implement this method ina concrete subclass.

Specified by:

render in class FreeMarkerTag

Parameters:

params - this is a list of parameters as provided to tag in HTML.

body - body of tag

writer - writer to write output to.

Throws:

Exception - if any