org.ofbiz.widget.html
Class HtmlFormWrapper

java.lang.Object
  org.ofbiz.widget.html.HtmlFormWrapper

public class HtmlFormWrapper
extends java.lang.Object

Widget Library - HTML Form Wrapper class - makes it easy to do the setup and render of a form

Field Summary

protected java.util.Map<java.lang.String,java.lang.Object>	context
protected java.lang.String	formName
protected ModelForm	modelForm
static java.lang.String	module
protected FormStringRenderer	renderer
protected HttpServletRequest	request
protected java.lang.String	resourceName
protected HttpServletResponse	response

Constructor Summary

protected	HtmlFormWrapper()
	HtmlFormWrapper(java.lang.String resourceName, java.lang.String formName, HttpServletRequest request, HttpServletResponse response)

Method Summary

java.lang.Object	getFromContext(java.lang.String name)
boolean	getIsError()
ModelForm	getModelForm()
FormStringRenderer	getRenderer()
boolean	getUseRequestParameters()
void	putInContext(java.lang.String name, java.lang.Object value)
java.io.StringWriter	renderFormString()
java.io.StringWriter	renderFormString(MapStack<java.lang.String> contextStack)
java.io.StringWriter	renderFormString(java.lang.Object contextStack)
void	setFormOverrideName(java.lang.String formName)
void	setIsError(boolean isError) Tells the form library whether this is a response to an error or not.
void	setRenderer(FormStringRenderer renderer)
void	setUseRequestParameters(boolean useRequestParameters) The "useRequestParameters" value in the form context tells the form library to use the request parameters to fill in values instead of the value map.

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

resourceName

protected java.lang.String resourceName

formName

protected java.lang.String formName

request

protected HttpServletRequest request

response

protected HttpServletResponse response

modelForm

protected ModelForm modelForm

renderer

protected FormStringRenderer renderer

context

protected java.util.Map<java.lang.String,java.lang.Object> context

Constructor Detail

HtmlFormWrapper

protected HtmlFormWrapper()

HtmlFormWrapper

public HtmlFormWrapper(java.lang.String resourceName,
                       java.lang.String formName,
                       HttpServletRequest request,
                       HttpServletResponse response)
                throws java.io.IOException,
                       org.xml.sax.SAXException,
                       javax.xml.parsers.ParserConfigurationException

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

Method Detail

renderFormString

public java.io.StringWriter renderFormString(java.lang.Object contextStack)
                                      throws java.io.IOException

Throws:

java.io.IOException

renderFormString

public java.io.StringWriter renderFormString(MapStack<java.lang.String> contextStack)
                                      throws java.io.IOException

Throws:

java.io.IOException

renderFormString

public java.io.StringWriter renderFormString()
                                      throws java.io.IOException

Throws:

java.io.IOException

setIsError

public void setIsError(boolean isError)

Tells the form library whether this is a response to an error or not. Defaults on initialization according to the presense of an errorMessage in the request or if an isError parameter was passed to the page with the value "true". If true then the prefilled values will come from the parameters Map instead of the value Map.

getIsError

public boolean getIsError()

setUseRequestParameters

public void setUseRequestParameters(boolean useRequestParameters)

The "useRequestParameters" value in the form context tells the form library to use the request parameters to fill in values instead of the value map. This is generally used when it is an empty form to pre-set inital values. This is automatically set to false for list and multi forms. For related functionality see the setIsError method.

Parameters:

useRequestParameters -

getUseRequestParameters

public boolean getUseRequestParameters()

setFormOverrideName

public void setFormOverrideName(java.lang.String formName)

putInContext

public void putInContext(java.lang.String name,
                         java.lang.Object value)

getFromContext

public java.lang.Object getFromContext(java.lang.String name)

getModelForm

public ModelForm getModelForm()

getRenderer

public FormStringRenderer getRenderer()

setRenderer

public void setRenderer(FormStringRenderer renderer)