org.apache.struts.taglib.html

Class FormTag

Known Direct Subclasses:
NestedFormTag

public class FormTag
extends TagSupport

Custom tag that represents an input form, associated with a bean whose properties correspond to the various fields of the form.
Version:
$Rev: 331056 $ $Date: 2005-11-06 01:29:01 +0000 (Sun, 06 Nov 2005) $

Field Summary

protected String
acceptCharset
The list of character encodings for input data that the server should accept.
protected String
action
The action URL to which this form should be submitted, if any.
protected String
beanName
The name of the form bean to (create and) use.
protected String
beanScope
The scope of the form bean to (create and) use.
protected String
beanType
The type of the form bean to (create and) use.
private boolean
disabled
Controls whether child controls should be 'disabled'.
protected String
enctype
The content encoding to be used on a POST submit.
protected String
focus
The name of the field to receive focus, if any.
protected String
focusIndex
The index in the focus field array to receive focus.
protected static String
lineEnd
The line ending string.
protected ActionMapping
mapping
The ActionMapping defining where we will be submitting this form
protected static MessageResources
messages
The message resources for this package.
protected String
method
The request method used when submitting this form.
protected ModuleConfig
moduleConfig
The module configuration for our module.
protected String
onreset
The onReset event script.
protected String
onsubmit
The onSubmit event script.
protected boolean
readonly
Controls whether child controls should be 'readonly'.
protected boolean
scriptLanguage
Include language attribute in the focus script's <script> element.
protected ActionServlet
servlet
The ActionServlet instance we are associated with (so that we can initialize the servlet property on any form bean that we create).
protected String
style
The style attribute associated with this tag.
protected String
styleClass
The style class associated with this tag.
protected String
styleId
The identifier associated with this tag.
protected String
target
The window target.

Method Summary

int
doEndTag()
Render the end of this form.
int
doStartTag()
Render the beginning of this form.
String
getAcceptCharset()
Return the list of character encodings accepted.
String
getAction()
Return the action URL to which this form should be submitted.
String
getBeanName()
Return the name of the form bean corresponding to this tag.
String
getEnctype()
Return the content encoding used when submitting this form.
String
getFocus()
Return the focus field name for this form.
String
getFocusIndex()
Returns the focusIndex.
String
getMethod()
Return the request method used when submitting this form.
String
getOnreset()
Return the onReset event script.
String
getOnsubmit()
Return the onSubmit event script.
boolean
getScriptLanguage()
Gets whether or not the focus script's <script> element will include the language attribute.
String
getStyle()
Return the style attribute for this tag.
String
getStyleClass()
Return the style class for this tag.
String
getStyleId()
Return the style identifier for this tag.
String
getTarget()
Return the window target.
protected void
initFormBean()
Locate or create the bean associated with our form.
boolean
isDisabled()
Returns the disabled event handler.
boolean
isReadonly()
Returns the readonly event handler.
private boolean
isXhtml()
Returns true if this tag should render as xhtml.
protected void
lookup()
Look up values for the name, scope, and type properties if necessary.
void
release()
Release any acquired resources.
protected void
renderAction(StringBuffer results)
Renders the action attribute
protected void
renderAttribute(StringBuffer results, String attribute, String value)
Renders attribute="value" if not null
protected String
renderFocusJavascript()
Generates javascript to set the initial focus to the form element given in the tag's "focus" attribute.
protected String
renderFormStartElement()
Generates the opening <form> element with appropriate attributes.
protected void
renderName(StringBuffer results)
Renders the name of the form.
protected void
renderOtherAttributes(StringBuffer results)
'Hook' to enable this tag to be extended and additional attributes added.
protected String
renderToken()
Generates a hidden input field with token information, if any.
void
setAcceptCharset(String acceptCharset)
Set the list of character encodings accepted.
void
setAction(String action)
Set the action URL to which this form should be submitted.
void
setDisabled(boolean disabled)
Sets the disabled event handler.
void
setEnctype(String enctype)
Set the content encoding used when submitting this form.
void
setFocus(String focus)
Set the focus field name for this form.
void
setFocusIndex(String focusIndex)
Sets the focusIndex.
void
setMethod(String method)
Set the request method used when submitting this form.
void
setOnreset(String onReset)
Set the onReset event script.
void
setOnsubmit(String onSubmit)
Set the onSubmit event script.
void
setReadonly(boolean readonly)
Sets the readonly event handler.
void
setScriptLanguage(boolean scriptLanguage)
Sets whether or not the focus script's <script> element will include the language attribute.
void
setStyle(String style)
Set the style attribute for this tag.
void
setStyleClass(String styleClass)
Set the style class for this tag.
void
setStyleId(String styleId)
Set the style identifier for this tag.
void
setTarget(String target)
Set the window target.

Field Details

acceptCharset

protected String acceptCharset
The list of character encodings for input data that the server should accept.

action

protected String action
The action URL to which this form should be submitted, if any.

beanName

protected String beanName
The name of the form bean to (create and) use. This is either the same as the 'name' attribute, if that was specified, or is obtained from the associated ActionMapping otherwise.

beanScope

protected String beanScope
The scope of the form bean to (create and) use. This is either the same as the 'scope' attribute, if that was specified, or is obtained from the associated ActionMapping otherwise.

beanType

protected String beanType
The type of the form bean to (create and) use. This is either the same as the 'type' attribute, if that was specified, or is obtained from the associated ActionMapping otherwise.

disabled

private boolean disabled
Controls whether child controls should be 'disabled'.

enctype

protected String enctype
The content encoding to be used on a POST submit.

focus

protected String focus
The name of the field to receive focus, if any.

focusIndex

protected String focusIndex
The index in the focus field array to receive focus. This only applies if the field given in the focus attribute is actually an array of fields. This allows a specific field in a radio button array to receive focus while still allowing indexed field names like "myRadioButtonField[1]" to be passed in the focus attribute.
Since:
Struts 1.1

lineEnd

protected static String lineEnd
The line ending string.

mapping

protected ActionMapping mapping
The ActionMapping defining where we will be submitting this form

messages

protected static MessageResources messages
The message resources for this package.

method

protected String method
The request method used when submitting this form.

moduleConfig

protected ModuleConfig moduleConfig
The module configuration for our module.

onreset

protected String onreset
The onReset event script.

onsubmit

protected String onsubmit
The onSubmit event script.

readonly

protected boolean readonly
Controls whether child controls should be 'readonly'.

scriptLanguage

protected boolean scriptLanguage
Include language attribute in the focus script's <script> element. This property is ignored in XHTML mode.
Since:
Struts 1.2

servlet

protected ActionServlet servlet
The ActionServlet instance we are associated with (so that we can initialize the servlet property on any form bean that we create).

style

protected String style
The style attribute associated with this tag.

styleClass

protected String styleClass
The style class associated with this tag.

styleId

protected String styleId
The identifier associated with this tag.

target

protected String target
The window target.

Method Details

doEndTag

public int doEndTag()
            throws JspException
Render the end of this form.

doStartTag

public int doStartTag()
            throws JspException
Render the beginning of this form.

getAcceptCharset

public String getAcceptCharset()
Return the list of character encodings accepted.

getAction

public String getAction()
Return the action URL to which this form should be submitted.

getBeanName

public String getBeanName()
Return the name of the form bean corresponding to this tag. There is no corresponding setter method; this method exists so that the nested tag classes can obtain the actual bean name derived from other attributes of the tag.

getEnctype

public String getEnctype()
Return the content encoding used when submitting this form.

getFocus

public String getFocus()
Return the focus field name for this form.

getFocusIndex

public String getFocusIndex()
Returns the focusIndex.
Returns:
String

getMethod

public String getMethod()
Return the request method used when submitting this form.

getOnreset

public String getOnreset()
Return the onReset event script.

getOnsubmit

public String getOnsubmit()
Return the onSubmit event script.

getScriptLanguage

public boolean getScriptLanguage()
Gets whether or not the focus script's <script> element will include the language attribute.
Returns:
true if language attribute will be included.
Since:
Struts 1.2

getStyle

public String getStyle()
Return the style attribute for this tag.

getStyleClass

public String getStyleClass()
Return the style class for this tag.

getStyleId

public String getStyleId()
Return the style identifier for this tag.

getTarget

public String getTarget()
Return the window target.

initFormBean

protected void initFormBean()
            throws JspException
Locate or create the bean associated with our form.
Since:
Struts 1.1

isDisabled

public boolean isDisabled()
Returns the disabled event handler.

isReadonly

public boolean isReadonly()
Returns the readonly event handler.

isXhtml

private boolean isXhtml()
Returns true if this tag should render as xhtml.

lookup

protected void lookup()
            throws JspException
Look up values for the name, scope, and type properties if necessary.

release

public void release()
Release any acquired resources.

renderAction

protected void renderAction(StringBuffer results)
Renders the action attribute

renderAttribute

protected void renderAttribute(StringBuffer results,
                               String attribute,
                               String value)
Renders attribute="value" if not null

renderFocusJavascript

protected String renderFocusJavascript()
Generates javascript to set the initial focus to the form element given in the tag's "focus" attribute.
Since:
Struts 1.1

renderFormStartElement

protected String renderFormStartElement()
Generates the opening <form> element with appropriate attributes.
Since:
Struts 1.1

renderName

protected void renderName(StringBuffer results)
Renders the name of the form. If XHTML is set to true, the name will be rendered as an 'id' attribute, otherwise as a 'name' attribute.

renderOtherAttributes

protected void renderOtherAttributes(StringBuffer results)
'Hook' to enable this tag to be extended and additional attributes added.

renderToken

protected String renderToken()
Generates a hidden input field with token information, if any. The field is added within a div element for HTML 4.01 Strict compliance.
Returns:
A hidden input field containing the token.
Since:
Struts 1.1

setAcceptCharset

public void setAcceptCharset(String acceptCharset)
Set the list of character encodings accepted.
Parameters:
acceptCharset - The list of character encodings

setAction

public void setAction(String action)
Set the action URL to which this form should be submitted.
Parameters:
action - The new action URL

setDisabled

public void setDisabled(boolean disabled)
Sets the disabled event handler.

setEnctype

public void setEnctype(String enctype)
Set the content encoding used when submitting this form.
Parameters:
enctype - The new content encoding

setFocus

public void setFocus(String focus)
Set the focus field name for this form.
Parameters:
focus - The new focus field name

setFocusIndex

public void setFocusIndex(String focusIndex)
Sets the focusIndex.
Parameters:
focusIndex - The focusIndex to set

setMethod

public void setMethod(String method)
Set the request method used when submitting this form.
Parameters:
method - The new request method

setOnreset

public void setOnreset(String onReset)
Set the onReset event script.
Parameters:
onReset - The new event script

setOnsubmit

public void setOnsubmit(String onSubmit)
Set the onSubmit event script.
Parameters:
onSubmit - The new event script

setReadonly

public void setReadonly(boolean readonly)
Sets the readonly event handler.

setScriptLanguage

public void setScriptLanguage(boolean scriptLanguage)
Sets whether or not the focus script's <script> element will include the language attribute.
Since:
Struts 1.2

setStyle

public void setStyle(String style)
Set the style attribute for this tag.
Parameters:
style - The new style attribute

setStyleClass

public void setStyleClass(String styleClass)
Set the style class for this tag.
Parameters:
styleClass - The new style class

setStyleId

public void setStyleId(String styleId)
Set the style identifier for this tag.
Parameters:
styleId - The new style identifier

setTarget

public void setTarget(String target)
Set the window target.
Parameters:
target - The new window target

Copyright B) 2000-2007 - The Apache Software Foundation