com.sapportals.portal.prt.util.html
Class HtmlForm

java.lang.Object
  |
  +--com.sapportals.portal.prt.util.html.HtmlAttributeContainer
        |
        +--com.sapportals.portal.prt.util.html.HtmlBase
              |
              +--com.sapportals.portal.prt.util.html.HtmlContainer
                    |
                    +--com.sapportals.portal.prt.util.html.HtmlContainerIdentifiable
                          |
                          +--com.sapportals.portal.prt.util.html.HtmlForm

All Implemented Interfaces:

IHtmlAttributeContainer, IHtmlBase, IHtmlIdentifiable, IHtmlOutputable

public class HtmlForm

extends HtmlContainerIdentifiable

HtmlForm.java Created: Wed Nov 03 18:49:33 1999

Version:

$Revision: #3 $

Inner Class Summary

static class

HtmlForm.FormMethod

Field Summary

protected java.lang.String	m_action URL of the program to call
protected HtmlForm.FormMethod	m_method how to transfer the data to the program on submit.
protected java.lang.String	m_name The name of the forl
protected java.lang.String	m_onReset onReset runs a script when the user resets the form.
protected java.lang.String	m_onSubmit onSubmit is a scripting event that occurs when the user attempts to submit the form . onSubmit can be used to do some error checking on the form data, and to cancel the submit if an error is found.
protected java.lang.String	m_target TARGET indicates which frame in a set of frames to send the results to, and works just like .

Fields inherited from class com.sapportals.portal.prt.util.html.HtmlContainer

m_htmlElements

Fields inherited from class com.sapportals.portal.prt.util.html.HtmlBase

m_hasTag

Fields inherited from class com.sapportals.portal.prt.util.html.HtmlAttributeContainer

EQUALS_BEGIN, EQUALS_END, m_attributes, SPACE

Constructor Summary

HtmlForm()

Method Summary

java.lang.String	getAction() Get the value of m_action.
HtmlForm.FormMethod	getMethod() Get the value of m_method.
java.lang.String	getName() Get the value of m_name.
java.lang.String	getOnReset() Get the value of m_onReset.
java.lang.String	getOnSubmit() Get the value of m_onSubmit.
java.lang.String	getTarget() Get the value of m_target.
void	outputAttributes(java.io.PrintWriter out) Deprecated.
void	outputAttributes(java.lang.StringBuffer strbuf)
void	outputAttributes(java.io.Writer out)
HtmlForm	setAction(java.lang.String v) Set the value of m_action.
HtmlForm	setMethod(HtmlForm.FormMethod v) Set the value of m_method.
HtmlForm	setName(java.lang.String v) Set the value of m_name.
HtmlForm	setOnReset(java.lang.String v) Set the value of m_onReset.
HtmlForm	setOnSubmit(java.lang.String v) Set the value of m_onSubmit.
HtmlForm	setTarget(java.lang.String v) Set the value of m_target.

Methods inherited from class com.sapportals.portal.prt.util.html.HtmlContainerIdentifiable

destroy, setID

Methods inherited from class com.sapportals.portal.prt.util.html.HtmlContainer

addElement, addElement, getElementCount, getHtmlElements, output, output, output, outputChildren, outputChildren, outputEndTag, outputEndTag, outputStartTag, outputStartTag, removeAllElements, removeElement, setHtmlElements, toString

Methods inherited from class com.sapportals.portal.prt.util.html.HtmlBase

getTag, hasTag, requireClosingTag, requireClosingTag, setClass, setStyle, setTag

Methods inherited from class com.sapportals.portal.prt.util.html.HtmlAttributeContainer

addAttribute, appendToAttribute, getAttributes, removeAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sapportals.portal.prt.util.html.IHtmlIdentifiable

setClass

Field Detail

m_action

protected java.lang.String m_action

URL of the program to call

m_method

protected HtmlForm.FormMethod m_method

how to transfer the data to the program on submit.

m_name

protected java.lang.String m_name

The name of the forl

m_target

protected java.lang.String m_target

TARGET indicates which frame in a set of frames to send the results to, and works just like . This attribute can be used so that the form is always visible even as the form results are displayed and redisplayed.

m_onSubmit

protected java.lang.String m_onSubmit

onSubmit is a scripting event that occurs when the user attempts to submit the form . onSubmit can be used to do some error checking on the form data, and to cancel the submit if an error is found.

m_onReset

protected java.lang.String m_onReset

onReset runs a script when the user resets the form. If onReset returns false, the reset is cancelled. Often when people hit reset they don't really mean to reset all their typing, they just hit it accidentally. onReset gives them a chance to cancel the action.

Constructor Detail

HtmlForm

public HtmlForm()

Method Detail

outputAttributes

public void outputAttributes(java.lang.StringBuffer strbuf)

Overrides:

outputAttributes in class HtmlAttributeContainer

outputAttributes

public void outputAttributes(java.io.PrintWriter out)

Deprecated.

Overrides:

outputAttributes in class HtmlAttributeContainer

Following copied from interface: com.sapportals.portal.prt.util.html.IHtmlAttributeContainer

Parameters:

writer -

outputAttributes

public void outputAttributes(java.io.Writer out)

Overrides:

outputAttributes in class HtmlAttributeContainer

getAction

public java.lang.String getAction()

Get the value of m_action.

Returns:

Value of m_action.

setAction

public HtmlForm setAction(java.lang.String v)

Set the value of m_action.

Parameters:

v - Value to assign to m_action.

getMethod

public HtmlForm.FormMethod getMethod()

Get the value of m_method.

Returns:

Value of m_method.

setMethod

public HtmlForm setMethod(HtmlForm.FormMethod v)

Set the value of m_method.

Parameters:

v - Value to assign to m_method.

getName

public java.lang.String getName()

Get the value of m_name.

Returns:

Value of m_name.

setName

public HtmlForm setName(java.lang.String v)

Set the value of m_name.

Parameters:

v - Value to assign to m_name.

getTarget

public java.lang.String getTarget()

Get the value of m_target.

Returns:

Value of m_target.

setTarget

public HtmlForm setTarget(java.lang.String v)

Set the value of m_target.

Parameters:

v - Value to assign to m_target.

getOnSubmit

public java.lang.String getOnSubmit()

Get the value of m_onSubmit.

Returns:

Value of m_onSubmit.

setOnSubmit

public HtmlForm setOnSubmit(java.lang.String v)

Set the value of m_onSubmit.

Parameters:

v - Value to assign to m_onSubmit.

getOnReset

public java.lang.String getOnReset()

Get the value of m_onReset.

Returns:

Value of m_onReset.

setOnReset

public HtmlForm setOnReset(java.lang.String v)

Set the value of m_onReset.

Parameters:

v - Value to assign to m_onReset.