com.plumtree.xpshared.htmlelements
Class HTMLElementCollection

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

public class HTMLElementCollection
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
HTMLElementCollection()
          Creates a new HTMLElementCollection 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.
protected  void InternalWrite(boolean bFormat, XPStringBuilder sbLocal, IXPResponse response)
          HTMLElement.InternalWrite rewritten for HTMLElementCollection.
protected  boolean ProvidesClosingTag()
          Indicates whether or not this HTML element provides a closing tag.
 void SetName(java.lang.String s)
          Method rewritten to disallow calling on an HTMLElementCollection
 void SetOnClick(java.lang.String s)
          Method rewritten to disallow calling on an HTMLElementCollection
 void SetOnKeyDown(java.lang.String s)
          Method rewritten to disallow calling on an HTMLElementCollection
 void SetOnKeyPress(java.lang.String s)
          Method rewritten to disallow calling on an HTMLElementCollection
 void SetOnMouseOut(java.lang.String s)
          Method rewritten to disallow calling on an HTMLElementCollection
 void SetOnMouseOver(java.lang.String s)
          Method rewritten to disallow calling on an HTMLElementCollection
 void SetStyle(java.lang.String s)
          Method rewritten to disallow calling on an HTMLElementCollection
 void SetStyleClass(StyleClass s)
          Method rewritten to disallow calling on an HTMLElementCollection
 
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, 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

HTMLElementCollection

public HTMLElementCollection()
Creates a new HTMLElementCollection object.

Method Detail

SetName

public final void SetName(java.lang.String s)
Method rewritten to disallow calling on an HTMLElementCollection

Overrides:
SetName in class HTMLElement
Parameters:
s - String
Throws:
HTMLException - This method will throw an exception.

SetOnClick

public final void SetOnClick(java.lang.String s)
Method rewritten to disallow calling on an HTMLElementCollection

Overrides:
SetOnClick in class HTMLElement
Parameters:
s - String
Throws:
HTMLException - This method will throw an exception.

SetOnKeyDown

public final void SetOnKeyDown(java.lang.String s)
Method rewritten to disallow calling on an HTMLElementCollection

Overrides:
SetOnKeyDown in class HTMLElement
Parameters:
s - String
Throws:
HTMLException - This method will throw an exception.

SetOnKeyPress

public final void SetOnKeyPress(java.lang.String s)
Method rewritten to disallow calling on an HTMLElementCollection

Overrides:
SetOnKeyPress in class HTMLElement
Parameters:
s - String
Throws:
HTMLException - This method will throw an exception.

SetOnMouseOut

public final void SetOnMouseOut(java.lang.String s)
Method rewritten to disallow calling on an HTMLElementCollection

Overrides:
SetOnMouseOut in class HTMLElement
Parameters:
s - String
Throws:
HTMLException - This method will throw an exception.

SetOnMouseOver

public final void SetOnMouseOver(java.lang.String s)
Method rewritten to disallow calling on an HTMLElementCollection

Overrides:
SetOnMouseOver in class HTMLElement
Parameters:
s - String
Throws:
HTMLException - This method will throw an exception.

SetStyle

public final void SetStyle(java.lang.String s)
Method rewritten to disallow calling on an HTMLElementCollection

Overrides:
SetStyle in class HTMLElement
Parameters:
s - String
Throws:
HTMLException - This method will throw an exception.

SetStyleClass

public void SetStyleClass(StyleClass s)
Method rewritten to disallow calling on an HTMLElementCollection

Overrides:
SetStyleClass in class HTMLElement
Parameters:
s - StyleClass
Throws:
HTMLException - This method will throw an exception.

InternalWrite

protected void InternalWrite(boolean bFormat,
                             XPStringBuilder sbLocal,
                             IXPResponse response)
HTMLElement.InternalWrite rewritten for HTMLElementCollection.

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.



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