com.plumtree.xpshared.htmlelements
Class HTMLFrame

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

All Implemented Interfaces:

java.lang.Cloneable

public class HTMLFrame
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

HTMLFrame()
Creates a new HTMLFrame 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	GetFrameBorder() Get the value of the frameborder attribute.
java.lang.String	GetLongDesc()
java.lang.String	GetMarginHeight() Get the value of the marginheight attribute.
java.lang.String	GetMarginWidth() Get the value of the marginwidth attribute.
boolean	GetNoResize() Get the value of the noresize attribute.
java.lang.String	GetScrolling() Get the value of the scrolling attribute.
java.lang.String	GetSrc() Get the value of the src attribute.
java.lang.String	GetTitle()
protected boolean	ProvidesClosingTag() Indicates whether or not this HTML element provides a closing tag.
void	SetFrameBorder(java.lang.String s) Set the value of the frameborder attribute.
void	SetLongDesc(java.lang.String s)
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	SetNoResize(boolean b) Set the value of the noresize attribute.
void	SetScrolling(java.lang.String s) Set the value of the scrolling attribute.
void	SetSrc(java.lang.String s) Set the value of the src attribute.
void	SetTitle(java.lang.String s)

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, 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, SetValidationLevel, ToByteArray, VerifyWritability, WriteNugget, WriteNugget

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLFrame

public HTMLFrame()

Creates a new HTMLFrame object.

Method Detail

SetLongDesc

public void SetLongDesc(java.lang.String s)

GetLongDesc

public java.lang.String GetLongDesc()

SetTitle

public void SetTitle(java.lang.String s)

Overrides:

SetTitle in class HTMLElement

GetTitle

public java.lang.String GetTitle()

Overrides:

GetTitle in class HTMLElement

GetFrameBorder

public java.lang.String GetFrameBorder()

Get the value of the frameborder 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

GetNoResize

public boolean GetNoResize()

Get the value of the noresize attribute.

Returns:

boolean value

GetScrolling

public java.lang.String GetScrolling()

Get the value of the scrolling attribute.

Returns:

String value

GetSrc

public java.lang.String GetSrc()

Get the value of the src attribute.

Returns:

String value

SetFrameBorder

public void SetFrameBorder(java.lang.String s)

Set the value of the frameborder attribute.

Parameters:

s - A valid String value.

SetMarginHeight

public void SetMarginHeight(java.lang.String s)

Set the value of the marginheight attribute.

Parameters:

s - A valid String value.

SetMarginWidth

public void SetMarginWidth(java.lang.String s)

Set the value of the marginwidth attribute.

Parameters:

s - A valid String value.

SetNoResize

public void SetNoResize(boolean b)

Set the value of the noresize attribute.

Parameters:

b - boolean value.

SetScrolling

public void SetScrolling(java.lang.String s)

Set the value of the scrolling attribute.

Parameters:

s - A valid String value.

SetSrc

public void SetSrc(java.lang.String s)

Set the value of the src attribute.

Parameters:

s - 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.