com.opensymphony.webwork.components
Class Form

java.lang.Object
  com.opensymphony.webwork.components.Component
      com.opensymphony.webwork.components.UIBean
          com.opensymphony.webwork.components.ClosingUIBean
              com.opensymphony.webwork.components.Form

public class Form
extends ClosingUIBean

Renders HTML an input form.

The remote form allows the form to be submitted without the page being refreshed. The results from the form can be inserted into any HTML element on the page.

NOTE:

The order / logic in determining the posting url of the generated HTML form is as follows:-

1. If the action attribute is not specified, then the current request will be used to determine the posting url
2. If the action is given, WebWork will try to obtain an ActionConfig. This will be successfull if the action attribute is a valid action alias defined xwork.xml.
3. If the action is given and is not an action alias defined in xwork.xml WebWork will used the action attribute as if it is the posting url, separting the namespace from it and using UrlHelper to generate the final url.

Examples

 

 <ww:form ... />

 
 

Since:

2.2

Version:

$Date: 2007-01-14 10:33:47 +0100 (Sun, 14 Jan 2007) $ $Id: Form.java 2805 2007-01-14 09:33:47Z tmjee $

Author:

Patrick Lightbody, Ian Roughley, Rene Gielen, Rainer Hermanns

Field Summary

protected String	acceptcharset
protected String	action
protected String	enctype
protected String	method
protected String	namespace
protected String	onsubmit
static String	OPEN_TEMPLATE
protected String	portletMode
protected String	target
static String	TEMPLATE
protected String	validate
protected String	windowState

Fields inherited from class com.opensymphony.webwork.components.UIBean

accesskey, cssClass, cssStyle, disabled, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateSuffix, theme, title, tooltip, tooltipConfig, value

Fields inherited from class com.opensymphony.webwork.components.Component

COMPONENT_STACK, id, parameters, stack

Constructor Summary

Form(com.opensymphony.xwork.util.OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response)

Method Summary

protected void	evaluateExtraParams()
protected boolean	evaluateNameValue()
String	getDefaultOpenTemplate()
protected String	getDefaultTemplate() A contract that requires each concrete UI Tag to specify which template should be used as a default.
protected int	getSequence() Get a incrementing sequence unique to this Form component.
List	getValidators(String name)
protected void	populateComponentHtmlId(Form form) Form component determine the its HTML element id as follows:- if an 'id' attribute is specified.
void	setAcceptcharset(String acceptcharset) The accepted charsets for this form.
void	setAction(String action) Set action nane to submit to, without .action suffix
void	setEnctype(String enctype) HTML form enctype attribute
void	setMethod(String method) HTML form method attribute
void	setNamespace(String namespace) namespace for action to submit to
void	setOnsubmit(String onsubmit) HTML onsubmit attribute
void	setPortletMode(String portletMode) The portlet mode to display after the form submit
void	setTarget(String target) HTML form target attribute
void	setValidate(String validate) Whether client side/remote validation should be performed.
void	setWindowState(String windowState) The window state to display after the form submit

Methods inherited from class com.opensymphony.webwork.components.ClosingUIBean

setOpenTemplate, start

Methods inherited from class com.opensymphony.webwork.components.UIBean

addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, mergeTemplate, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, setLabelposition, setLabelPosition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTheme, setTitle, setTooltip, setTooltipConfig, setValue

Methods inherited from class com.opensymphony.webwork.components.Component

addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, toString, usesBody

Methods inherited from class java.lang.Object

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

Field Detail

OPEN_TEMPLATE

public static final String OPEN_TEMPLATE

See Also:

Constant Field Values

TEMPLATE

public static final String TEMPLATE

See Also:

Constant Field Values

onsubmit

protected String onsubmit

action

protected String action

target

protected String target

enctype

protected String enctype

method

protected String method

namespace

protected String namespace

validate

protected String validate

portletMode

protected String portletMode

windowState

protected String windowState

acceptcharset

protected String acceptcharset

Constructor Detail

Form

public Form(com.opensymphony.xwork.util.OgnlValueStack stack,
            HttpServletRequest request,
            HttpServletResponse response)

Method Detail

evaluateNameValue

protected boolean evaluateNameValue()

Overrides:

evaluateNameValue in class UIBean

getDefaultOpenTemplate

public String getDefaultOpenTemplate()

Specified by:

getDefaultOpenTemplate in class ClosingUIBean

getDefaultTemplate

protected String getDefaultTemplate()

Description copied from class: UIBean

A contract that requires each concrete UI Tag to specify which template should be used as a default. For example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value not begin with a '/' unless you intend to make the path absolute rather than relative to the current theme.

Specified by:

getDefaultTemplate in class UIBean

Returns:

The name of the template to be used as the default.

evaluateExtraParams

protected void evaluateExtraParams()

Overrides:

evaluateExtraParams in class UIBean

populateComponentHtmlId

protected void populateComponentHtmlId(Form form)

Form component determine the its HTML element id as follows:-

1. if an 'id' attribute is specified.
2. if an 'action' attribute is specified, it will be used as the id.

Overrides:

populateComponentHtmlId in class UIBean

getValidators

public List getValidators(String name)

getSequence

protected int getSequence()

Get a incrementing sequence unique to this Form component. It is used by Form component's child that might need a sequence to make them unique.

Returns:

int

setOnsubmit

public void setOnsubmit(String onsubmit)

HTML onsubmit attribute

setAction

public void setAction(String action)

Set action nane to submit to, without .action suffix

setTarget

public void setTarget(String target)

HTML form target attribute

setEnctype

public void setEnctype(String enctype)

HTML form enctype attribute

setMethod

public void setMethod(String method)

HTML form method attribute

setNamespace

public void setNamespace(String namespace)

namespace for action to submit to

setValidate

public void setValidate(String validate)

Whether client side/remote validation should be performed. Only useful with theme xhtml/ajax

setPortletMode

public void setPortletMode(String portletMode)

The portlet mode to display after the form submit

setWindowState

public void setWindowState(String windowState)

The window state to display after the form submit

setAcceptcharset

public void setAcceptcharset(String acceptcharset)

The accepted charsets for this form. The values may be comma or blank delimited.