com.plumtree.xpshared.htmlelements
Class HTMLBody

java.lang.Object
  extended by com.plumtree.xpshared.htmlelements.HTMLElement
      extended by com.plumtree.xpshared.htmlelements.HTMLBody
All Implemented Interfaces:
java.lang.Cloneable

public class HTMLBody
extends HTMLElement



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
HTMLBody()
          Creates a new HTMLBody object.
 
Method Summary
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 GetLeftMargin()
          Get the value of the leftmargin attribute.
 java.lang.String GetMarginHeight()
          Get the value of the marginheight attribute.
 java.lang.String GetMarginWidth()
          Get the value of the marginwidth attribute.
 java.lang.String GetOnActivate()
          Get the value of the onactivate attribute.
 java.lang.String GetOnAfterPrint()
          Get the value of the onafterprint attribute.
 java.lang.String GetOnBeforeActivate()
          Get the value of the onbeforeactivate attribute.
 java.lang.String GetOnBeforeUnload()
          Get the value of the onbeforeunload attribute.
 java.lang.String GetOnBlur()
          Get the value of the onblur attribute.
 java.lang.String GetOnControlSet()
          Get the value of the oncontrolset attribute.
 java.lang.String GetOnDeactivate()
          Get the value of the ondeactivate attribute.
 java.lang.String GetOnError()
          Get the value of the onerror attribute.
 java.lang.String GetOnFocus()
          Get the value of the onfocus attribute.
 java.lang.String GetOnHelp()
          Get the value of the onhelp attribute.
 java.lang.String GetOnLoad()
          Get the value of the onload attribute.
 java.lang.String GetOnResize()
          Get the value of the onresize attribute.
 java.lang.String GetOnResizeEnd()
          Get the value of the onresizeend attribute.
 java.lang.String GetOnResizeStart()
          Get the value of the onresizestart attribute.
 java.lang.String GetOnUnload()
          Get the value of the onunload attribute.
 java.lang.String GetTopMargin()
          Get the value of the topmargin attribute.
protected  boolean ProvidesClosingTag()
          Indicates whether or not this HTML element provides a closing tag.
 void SetLeftMargin(java.lang.String s)
          Set the value of the leftmargin attribute.
 void SetMarginHeight(java.lang.String s)
          Set the value of the marginheight attribute.
 void SetMarginWidth(java.lang.String s)
          Set the value of the marginwidth attribute.
 void SetOnActivate(java.lang.String s)
          Set the value of the onactivate attribute.
 void SetOnAfterPrint(java.lang.String s)
          Set the value of the onafterprint attribute.
 void SetOnBeforeActivate(java.lang.String s)
          Set the value of the onbeforeactivate attribute.
 void SetOnBeforeUnload(java.lang.String s)
          Set the value of the onbeforeunload attribute.
 void SetOnBlur(java.lang.String s)
          Set the value of the onblur attribute.
 void SetOnControlSet(java.lang.String s)
          Set the value of the oncontrolset attribute.
 void SetOnDeactivate(java.lang.String s)
          Set the value of the ondeactivate attribute.
 void SetOnError(java.lang.String s)
          Set the value of the onerror attribute.
 void SetOnFocus(java.lang.String s)
          Set the value of the onfocus attribute.
 void SetOnHelp(java.lang.String s)
          Set the value of the onhelp attribute.
 void SetOnLoad(java.lang.String s)
          Set the value of the onload attribute.
 void SetOnResize(java.lang.String s)
          Set the value of the onresize attribute.
 void SetOnResizeEnd(java.lang.String s)
          Set the value of the onresizeend attribute.
 void SetOnResizeStart(java.lang.String s)
          Set the value of the onresizestart attribute.
 void SetOnUnload(java.lang.String s)
          Set the value of the onunload attribute.
 void SetTopMargin(java.lang.String s)
          Set the value of the topmargin attribute.
 
Methods inherited from class com.plumtree.xpshared.htmlelements.HTMLElement
AddInnerHTMLElement, 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

HTMLBody

public HTMLBody()
Creates a new HTMLBody object.

Method Detail

GetLeftMargin

public java.lang.String GetLeftMargin()
Get the value of the leftmargin attribute.

Returns:
String value.

GetMarginHeight

public java.lang.String GetMarginHeight()
Get the value of the marginheight attribute.

Returns:
String value.

GetMarginWidth

public java.lang.String GetMarginWidth()
Get the value of the marginwidth attribute.

Returns:
String value.

GetOnActivate

public java.lang.String GetOnActivate()
Get the value of the onactivate attribute.

Returns:
String value.

GetOnAfterPrint

public java.lang.String GetOnAfterPrint()
Get the value of the onafterprint attribute.

Returns:
String value.

GetOnBeforeActivate

public java.lang.String GetOnBeforeActivate()
Get the value of the onbeforeactivate attribute.

Returns:
String value.

GetOnBeforeUnload

public java.lang.String GetOnBeforeUnload()
Get the value of the onbeforeunload attribute.

Returns:
String value.

GetOnBlur

public java.lang.String GetOnBlur()
Get the value of the onblur attribute.

Returns:
String value.

GetOnControlSet

public java.lang.String GetOnControlSet()
Get the value of the oncontrolset attribute.

Returns:
String value.

GetOnDeactivate

public java.lang.String GetOnDeactivate()
Get the value of the ondeactivate attribute.

Returns:
String value.

GetOnError

public java.lang.String GetOnError()
Get the value of the onerror attribute.

Returns:
String value.

GetOnFocus

public java.lang.String GetOnFocus()
Get the value of the onfocus attribute.

Returns:
String value.

GetOnHelp

public java.lang.String GetOnHelp()
Get the value of the onhelp attribute.

Returns:
String value.

GetOnLoad

public java.lang.String GetOnLoad()
Get the value of the onload attribute.

Returns:
String value.

GetOnResize

public java.lang.String GetOnResize()
Get the value of the onresize attribute.

Returns:
String value.

GetOnResizeEnd

public java.lang.String GetOnResizeEnd()
Get the value of the onresizeend attribute.

Returns:
String value.

GetOnResizeStart

public java.lang.String GetOnResizeStart()
Get the value of the onresizestart attribute.

Returns:
String value.

GetOnUnload

public java.lang.String GetOnUnload()
Get the value of the onunload attribute.

Returns:
String value.

GetTopMargin

public java.lang.String GetTopMargin()
Get the value of the topmargin attribute.

Returns:
String value.

SetLeftMargin

public void SetLeftMargin(java.lang.String s)
Set the value of the leftmargin attribute.

Parameters:
s - Pass a valid String value.

SetMarginHeight

public void SetMarginHeight(java.lang.String s)
Set the value of the marginheight attribute.

Parameters:
s - Pass a valid String value.

SetMarginWidth

public void SetMarginWidth(java.lang.String s)
Set the value of the marginwidth attribute.

Parameters:
s - Pass a valid String value.

SetOnActivate

public void SetOnActivate(java.lang.String s)
Set the value of the onactivate attribute.

Parameters:
s - Pass a valid String value.

SetOnAfterPrint

public void SetOnAfterPrint(java.lang.String s)
Set the value of the onafterprint attribute.

Parameters:
s - Pass a valid String value.

SetOnBeforeActivate

public void SetOnBeforeActivate(java.lang.String s)
Set the value of the onbeforeactivate attribute.

Parameters:
s - Pass a valid String value.

SetOnBeforeUnload

public void SetOnBeforeUnload(java.lang.String s)
Set the value of the onbeforeunload attribute.

Parameters:
s - Pass a valid String value.

SetOnBlur

public void SetOnBlur(java.lang.String s)
Set the value of the onblur attribute.

Parameters:
s - Pass a valid String value.

SetOnControlSet

public void SetOnControlSet(java.lang.String s)
Set the value of the oncontrolset attribute.

Parameters:
s - Pass a valid String value.

SetOnDeactivate

public void SetOnDeactivate(java.lang.String s)
Set the value of the ondeactivate attribute.

Parameters:
s - Pass a valid String value.

SetOnError

public void SetOnError(java.lang.String s)
Set the value of the onerror attribute.

Parameters:
s - Pass a valid String value.

SetOnFocus

public void SetOnFocus(java.lang.String s)
Set the value of the onfocus attribute.

Parameters:
s - Pass a valid String value.

SetOnHelp

public void SetOnHelp(java.lang.String s)
Set the value of the onhelp attribute.

Parameters:
s - Pass a valid String value.

SetOnLoad

public void SetOnLoad(java.lang.String s)
Set the value of the onload attribute.

Parameters:
s - Pass a valid String value.

SetOnResize

public void SetOnResize(java.lang.String s)
Set the value of the onresize attribute.

Parameters:
s - Pass a valid String value.

SetOnResizeEnd

public void SetOnResizeEnd(java.lang.String s)
Set the value of the onresizeend attribute.

Parameters:
s - Pass a valid String value.

SetOnResizeStart

public void SetOnResizeStart(java.lang.String s)
Set the value of the onresizestart attribute.

Parameters:
s - Pass a valid String value.

SetOnUnload

public void SetOnUnload(java.lang.String s)
Set the value of the onunload attribute.

Parameters:
s - Pass a valid String value.

SetTopMargin

public void SetTopMargin(java.lang.String s)
Set the value of the topmargin attribute.

Parameters:
s - Pass a valid String value.

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.



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.