Package org.deltava.taglib.html

Class FormTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.deltava.taglib.BrowserInfoTag

org.deltava.taglib.html.ElementTag

org.deltava.taglib.html.FormTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class FormTag
extends ElementTag

A JSP tag for generating HTML forms.

Since:

1.0

Version:

11.0

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.deltava.taglib.html.ElementTag

_classes, _data, _out

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
FormTag()	Creates a new Form element Tag.

Method Summary

Modifier and Type	Method	Description
int	doEndTag()
int	doStartTag()
boolean	getAllowUpload()	Returns whether RFC1867 file uploads are permitted within this form.
int	getTabIndex()	Returns the current tab index of this form.
(package private) int	incTabIndex()	Increments the current tab index, then returns the new value.
void	release()
void	setAction(String url)	Sets the action URL of this form.
void	setAllowUpload(boolean allowUpload)	Sets if RFC1867 file uploads are permitted within this form.
void	setLink(DatabaseBean db)	Sets the database ID to link to.
void	setLinkID(String id)	Sets the ID parameter for the command invocation.
void	setMethod(String postType)	Sets the action type of this form.
void	setOp(String opName)	Sets the command operation for this button.
void	setPageContext(PageContext ctxt)	Loads the UI scheme name from the user object, if present.
void	setSpinner(boolean doSpinner)	Sets whether to render the hidden spinner DIV.
void	setTarget(String target)	Sets the form target.
void	setValidate(String jsFunc)	Sets this form's JavaScript validation routine.

Methods inherited from class org.deltava.taglib.html.ElementTag

getFormIndexCount, getName, getParentFormTag, setClassName, setID, setNumericAttr, setStyle

Methods inherited from class org.deltava.taglib.BrowserInfoTag

getBrowserContext

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

FormTag

public FormTag()

Creates a new Form element Tag.

Method Details

setPageContext

public void setPageContext(PageContext ctxt)

Loads the UI scheme name from the user object, if present.

Specified by:

setPageContext in interface Tag

Overrides:

setPageContext in class ElementTag

Parameters:

ctxt - the JSP page context

doStartTag

public int doStartTag()
               throws JspException

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class ElementTag

Throws:

JspException

doEndTag

public int doEndTag()
             throws JspException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class TagSupport

Throws:

JspException

incTabIndex

int incTabIndex()

Increments the current tab index, then returns the new value.

Returns:

the new tab Index

getTabIndex

public int getTabIndex()

Returns the current tab index of this form.

Returns:

the current tab Index

getAllowUpload

public boolean getAllowUpload()

Returns whether RFC1867 file uploads are permitted within this form.

Returns:

TRUE if file uploads are permitted, otherwise FALSE

setLinkID

public void setLinkID(String id)

Sets the ID parameter for the command invocation. If it starts with "0x" then turn the rest of the string into a hexadecimal number string.

Parameters:

id - the parameter

See Also:

• HTTPContext.getCmdParameter(int, Object)

setLink

public void setLink(DatabaseBean db)

Sets the database ID to link to.

Parameters:

db - a DatabaseBean with the proper database ID

setOp

public void setOp(String opName)

Sets the command operation for this button.

Parameters:

opName - the operation name

See Also:

• HTTPContext.getCmdParameter(int, Object)

setMethod

public void setMethod(String postType)

Sets the action type of this form.

Parameters:

postType - the action type, typically GET or POST

setValidate

public void setValidate(String jsFunc)

Sets this form's JavaScript validation routine.

Parameters:

jsFunc - JavaScript code to be passed as the onSubmit attribute

setTarget

public void setTarget(String target)

Sets the form target.

Parameters:

target - the target frame name

setAction

public void setAction(String url)

Sets the action URL of this form.

Parameters:

url - the URL where this form data will be sent to on submit

setAllowUpload

public void setAllowUpload(boolean allowUpload)

Sets if RFC1867 file uploads are permitted within this form.

Parameters:

allowUpload - TRUE if file uploads are permitted, otherwise FALSE

setSpinner

public void setSpinner(boolean doSpinner)

Sets whether to render the hidden spinner DIV.

Parameters:

doSpinner - TRUE if the spinner DIV should be rendered, otherwise FALSE

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class ElementTag