com.plumtree.xpshared.htmlelements
Class HTMLForm

java.lang.Object
  com.plumtree.xpshared.htmlelements.HTMLElement
      com.plumtree.xpshared.htmlelements.HTMLForm

All Implemented Interfaces:

java.lang.Cloneable

public class HTMLForm
extends HTMLElement

This class can be used to display an HTML form element.

Spec

Nested Class Summary

Nested classes/interfaces inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

HTMLElement.ValidationLevel

Field Summary

Fields inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

aNewLine, bAllowEvents, bAllowSetStyleClassWithString, bCheckNestedStringForHTML, bDisplayDidPause, bEnforceMaxTableDepth, bForceFormattingOff, bForceFormattingOn, bPauseAfterDisplay, bPrintComments, bResumingAndChildFinished, bResumingAndChildInMidRender, bShowLang, iMaxTableDepth, sLangLocal, sNewLine, sTab

Constructor Summary

HTMLForm(java.lang.String sID)

Method Summary

void	AddInnerHTMLElement(HTMLElement e) Call this method to add a HTMLTableRow object to this table.
protected void	AppendBeginningOfOpeningTag(boolean bFormat, XPStringBuilder sb, IXPResponse response) This method generates the beginning of the opening tag.
protected void	AppendClosingTag(boolean bFormat, XPStringBuilder sb, IXPResponse response) This method generates the closing tag of this html element.
java.lang.String	GetAction() Get the value of the action attribute.
java.lang.String	GetEncType() Get the value of the enctype attribute.
java.lang.String	GetMethod() Get the value of the method attribute.
HTMLTable	GetParentTable()
protected boolean	ProvidesClosingTag() Indicates whether or not this HTML element provides a closing tag.
void	SetAction(java.lang.String s) Set the value of the action attribute.
void	SetEncType(java.lang.String s) Set the value of the enctype attribute.
void	SetMethod(java.lang.String s) Set the value of the method attribute.
void	SetOnSubmit(java.lang.String s) Set the value of the onsubmit attribute.
void	SetParentTable(HTMLTable table) An HTMLForm can be added to an HTMLTable.

Methods inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

AddInnerHTMLEncodedString, AddInnerHTMLString, AppendClosingLineBreak, CleanupHTMLSubtreeAfterRendering, ClearInnerHTMLElements, clone, Display, Display, ForceFormattingOff, GetChildInMidRender, GetClone, GetDisabled, GetDisplayDidPause, GetDisplayOptions, GetDisplayString, GetDisplayString, GetDisplayString, GetDo508Checking, GetDoFormat, GetElementName, GetForceLineBreaksAfterSafeElements, GetHTMLElementReadOnly, GetID, GetImgBaseUrl, GetInnerHTML, GetInnerHTML, GetInnerHTMLDisplayString, GetInnerHTMLElements, GetInnerHTMLElementsAsArrayList, GetIsNetscape, GetLang, GetLastChildFullyRendered, GetName, GetOnClick, GetOnKeyDown, GetOnKeyPress, GetOnKeyUp, GetOnMouseOut, GetOnMouseOver, GetPauseAfterDisplay, GetPostComment, GetPreComment, GetStringBuilder, GetStyle, GetStyleClass, GetStyleClassPrefix, GetTitle, GetValidationLevel, InsertInnerHTMLElement, InternalWrite, SaveToTempFile, SaveToTempFile, SetChildInMidRender, SetDisabled, SetDisplayOptions, SetDo508Checking, SetDoFormat, SetElementName, SetFlushAfterDisplay, SetForceLineBreaksAfterSafeElements, SetHTMLElementReadOnly, SetID, SetImgBaseUrl, SetInner, SetIsNetscape, SetLangGlobal, SetLangLocal, SetLastChildFullyRendered, SetName, SetOnClick, SetOnKeyDown, SetOnKeyPress, SetOnKeyUp, SetOnMouseOut, SetOnMouseOver, SetPauseAfterDisplay, SetPostComment, SetPreComment, SetStyle, SetStyleClass, SetStyleClass, SetStyleClassPrefix, SetTitle, SetValidationLevel, ToByteArray, VerifyWritability, WriteNugget, WriteNugget

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLForm

public HTMLForm(java.lang.String sID)

Parameters:

sID - Pass the id string of this form.

Throws:

HTMLException

Method Detail

GetAction

public java.lang.String GetAction()

Get the value of the action attribute.

Returns:

String value.

GetEncType

public java.lang.String GetEncType()

Get the value of the enctype attribute.

Returns:

String value.

GetMethod

public java.lang.String GetMethod()

Get the value of the method attribute.

Returns:

String value.

GetParentTable

public HTMLTable GetParentTable()

SetAction

public void SetAction(java.lang.String s)

Set the value of the action attribute.

Parameters:

s - A valid String value.

SetEncType

public void SetEncType(java.lang.String s)

Set the value of the enctype attribute.

Parameters:

s - A valid String value.

SetMethod

public void SetMethod(java.lang.String s)

Set the value of the method attribute.

Parameters:

s - Either "post" or "get".

Throws:

HTMLException

SetOnSubmit

public void SetOnSubmit(java.lang.String s)

Set the value of the onsubmit attribute.

Parameters:

s - String value.

SetParentTable

public void SetParentTable(HTMLTable table)

An HTMLForm can be added to an HTMLTable.

Parameters:

table -

AddInnerHTMLElement

public void AddInnerHTMLElement(HTMLElement e)
                         throws HTMLException

Call this method to add a HTMLTableRow object to this table. The HTMLTableRow passed as a parameter must have been constructed with a reference to this very HTMLTable.

Overrides:

AddInnerHTMLElement in class HTMLElement

Parameters:

e -

Throws:

HTMLException

AppendBeginningOfOpeningTag

protected void AppendBeginningOfOpeningTag(boolean bFormat,
                                           XPStringBuilder sb,
                                           IXPResponse response)

This method generates the beginning of the opening tag. The abstract HTMLElement superclass will provide the remainder of the opening tag, repleate with attributes common to all html elements, such as name, and id, and class.

Specified by:

AppendBeginningOfOpeningTag in class HTMLElement

Parameters:

bFormat - boolean indicating whether or not to format.

sb - XPStringBuilder

response - IXPResponse

AppendClosingTag

protected void AppendClosingTag(boolean bFormat,
                                XPStringBuilder sb,
                                IXPResponse response)

This method generates the closing tag of this html element. If the providesClosingTag method returns false, then this method will never be called.

Specified by:

AppendClosingTag in class HTMLElement

Parameters:

bFormat - boolean indicating whether or not to format.

sb - XPStringBuilder

response - IXPResponse

ProvidesClosingTag

protected boolean ProvidesClosingTag()

Indicates whether or not this HTML element provides a closing tag. Some elements only provide opening tags, such as the <br> element.

Specified by:

ProvidesClosingTag in class HTMLElement

Returns:

boolean true.