com.sapportals.portal.prt.util.html

Class HtmlForm

java.lang.Object
  extended by com.sapportals.portal.prt.util.html.HtmlAttributeContainer
      extended by com.sapportals.portal.prt.util.html.HtmlBase
          extended by com.sapportals.portal.prt.util.html.HtmlContainer
              extended by com.sapportals.portal.prt.util.html.HtmlContainerIdentifiable
                  extended by 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


Nested Class Summary
static class HtmlForm.FormMethod
           
 
Field Summary
protected  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  String m_name
          The name of the forl
protected  String m_onReset
          onReset runs a script when the user resets the form.
protected  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  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
 String getAction()
          Get the value of m_action.
 HtmlForm.FormMethod getMethod()
          Get the value of m_method.
 String getName()
          Get the value of m_name.
 String getOnReset()
          Get the value of m_onReset.
 String getOnSubmit()
          Get the value of m_onSubmit.
 String getTarget()
          Get the value of m_target.
 void outputAttributes(PrintWriter out)
          Deprecated.  
 void outputAttributes(StringBuffer strbuf)
           
 void outputAttributes(Writer out)
           
 HtmlForm setAction(String v)
          Set the value of m_action.
 HtmlForm setMethod(HtmlForm.FormMethod v)
          Set the value of m_method.
 HtmlForm setName(String v)
          Set the value of m_name.
 HtmlForm setOnReset(String v)
          Set the value of m_onReset.
 HtmlForm setOnSubmit(String v)
          Set the value of m_onSubmit.
 HtmlForm setTarget(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, addIsThreadXHTMLCompliant, appendToAttribute, getAttributes, isThreadXHTMLCompliant, removeAttribute, removeIsThreadXHTMLCompliant
 
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 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 String m_name
The name of the forl


m_target

protected 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 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 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(StringBuffer strbuf)
Specified by:
outputAttributes in interface IHtmlAttributeContainer
Overrides:
outputAttributes in class HtmlAttributeContainer

outputAttributes

public void outputAttributes(PrintWriter out)
Deprecated. 

Specified by:
outputAttributes in interface IHtmlAttributeContainer
Overrides:
outputAttributes in class HtmlAttributeContainer

outputAttributes

public void outputAttributes(Writer out)
Specified by:
outputAttributes in interface IHtmlAttributeContainer
Overrides:
outputAttributes in class HtmlAttributeContainer

getAction

public String getAction()
Get the value of m_action.

Returns:
Value of m_action.

setAction

public HtmlForm setAction(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 String getName()
Get the value of m_name.

Returns:
Value of m_name.

setName

public HtmlForm setName(String v)
Set the value of m_name.

Parameters:
v - Value to assign to m_name.

getTarget

public String getTarget()
Get the value of m_target.

Returns:
Value of m_target.

setTarget

public HtmlForm setTarget(String v)
Set the value of m_target.

Parameters:
v - Value to assign to m_target.

getOnSubmit

public String getOnSubmit()
Get the value of m_onSubmit.

Returns:
Value of m_onSubmit.

setOnSubmit

public HtmlForm setOnSubmit(String v)
Set the value of m_onSubmit.

Parameters:
v - Value to assign to m_onSubmit.

getOnReset

public String getOnReset()
Get the value of m_onReset.

Returns:
Value of m_onReset.

setOnReset

public HtmlForm setOnReset(String v)
Set the value of m_onReset.

Parameters:
v - Value to assign to m_onReset.
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-BASIS-API [sap.com] tc/epbc/prt/api api EP-PIN
[sap.com] EP-BASIS-API [sap.com] epbc.prtapi._apideprecated default EP-PIN-PRT


Copyright 2011 SAP AG Complete Copyright Notice