com.plumtree.xpshared.htmlelements
Class HTMLGenericElement

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

All Implemented Interfaces:

java.lang.Cloneable

public class HTMLGenericElement
extends HTMLElement

This class can be used to represent HTML elements for which no specific class exists.

It is far better thing to use a class specific to the element you wish to render, than to use this class.

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

HTMLGenericElement(java.lang.String s)
Call this method to create an HTMLGenericElement object.

Method Summary

void	AddInnerHTMLElement(HTMLElement e) Method rewritten to disallow calling on an HTMLGenericElement
void	AddInnerHTMLString(java.lang.String s) Method rewritten to disallow calling on an HTMLGenericElement
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.
protected void	InternalWrite(boolean bFormat, XPStringBuilder sbLocal, IXPResponse response) HTMLElement.InternalWrite() rewritten.
protected boolean	ProvidesClosingTag() Indicates whether or not this HTML element provides a closing tag.
void	SetDisplayString(java.lang.String s) Call this method to set the html string for this object.
void	SetName(java.lang.String s) Method rewritten to disallow calling on an HTMLGenericElement
void	SetOnClick(java.lang.String s) Method rewritten to disallow calling on an HTMLGenericElement
void	SetOnKeyDown(java.lang.String s) Method rewritten to disallow calling on an HTMLGenericElement
void	SetOnKeyPress(java.lang.String s) Method rewritten to disallow calling on an HTMLGenericElement
void	SetOnMouseOut(java.lang.String s) Method rewritten to disallow calling on an HTMLGenericElement
void	SetOnMouseOver(java.lang.String s) Method rewritten to disallow calling on an HTMLGenericElement
void	SetStyle(java.lang.String s) Method rewritten to disallow calling on an HTMLGenericElement
void	SetStyleClass(StyleClass s) Method rewritten to disallow calling on an HTMLGenericElement

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

AddInnerHTMLEncodedString, 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, SaveToTempFile, SaveToTempFile, SetChildInMidRender, SetDisabled, SetDisplayOptions, SetDo508Checking, SetDoFormat, SetElementName, SetFlushAfterDisplay, SetForceLineBreaksAfterSafeElements, SetHTMLElementReadOnly, SetID, SetImgBaseUrl, SetInner, SetIsNetscape, SetLangGlobal, SetLangLocal, SetLastChildFullyRendered, SetOnKeyUp, SetPauseAfterDisplay, SetPostComment, SetPreComment, 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

HTMLGenericElement

public HTMLGenericElement(java.lang.String s)

Call this method to create an HTMLGenericElement object.

Parameters:

s - Pass any valid HTML string.

Method Detail

SetDisplayString

public void SetDisplayString(java.lang.String s)

Call this method to set the html string for this object.

Parameters:

s - Pass a valid html string.

SetName

public void SetName(java.lang.String s)
             throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

SetName in class HTMLElement

Parameters:

s - String

Throws:

HTMLException - This method will throw an exception.

SetOnClick

public void SetOnClick(java.lang.String s)
                throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

SetOnClick in class HTMLElement

Parameters:

s - String

Throws:

HTMLException - This method will throw an exception.

SetOnKeyDown

public void SetOnKeyDown(java.lang.String s)
                  throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

SetOnKeyDown in class HTMLElement

Parameters:

s - String

Throws:

HTMLException - This method will throw an exception.

SetOnKeyPress

public void SetOnKeyPress(java.lang.String s)
                   throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

SetOnKeyPress in class HTMLElement

Parameters:

s - String

Throws:

HTMLException - This method will throw an exception.

SetOnMouseOut

public void SetOnMouseOut(java.lang.String s)
                   throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

SetOnMouseOut in class HTMLElement

Parameters:

s - String

Throws:

HTMLException - This method will throw an exception.

SetOnMouseOver

public void SetOnMouseOver(java.lang.String s)
                    throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

SetOnMouseOver in class HTMLElement

Parameters:

s - String

Throws:

HTMLException - This method will throw an exception.

SetStyle

public void SetStyle(java.lang.String s)
              throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

SetStyle in class HTMLElement

Parameters:

s - String

Throws:

HTMLException - This method will throw an exception.

SetStyleClass

public void SetStyleClass(StyleClass s)
                   throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

SetStyleClass in class HTMLElement

Parameters:

s - String

Throws:

HTMLException - This method will throw an exception.

AddInnerHTMLElement

public void AddInnerHTMLElement(HTMLElement e)
                         throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

AddInnerHTMLElement in class HTMLElement

Parameters:

e - HTMLElement

Throws:

HTMLException - This method will throw an exception.

AddInnerHTMLString

public void AddInnerHTMLString(java.lang.String s)
                        throws HTMLException

Method rewritten to disallow calling on an HTMLGenericElement

Overrides:

AddInnerHTMLString in class HTMLElement

Parameters:

s - HTMLElement

Throws:

HTMLException - This method will throw an exception.

InternalWrite

protected void InternalWrite(boolean bFormat,
                             XPStringBuilder sbLocal,
                             IXPResponse response)
                      throws HTMLException

HTMLElement.InternalWrite() rewritten.

Overrides:

InternalWrite in class HTMLElement

Parameters:

bFormat - Pass a boolean indicating whether or not to format the output.

sbLocal - Pass an XPStringBuilder to which you wish the String appended. Pass null if you do not wish the string appended to an XPStringBuilder.

response - Pass an IXPResponse to which you wish the String written. Pass null if you do not wish the string written to an IXPResponse.

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