com.plumtree.xpshared.htmlelements
Class HTMLTable

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

public class HTMLTable
extends HTMLElement

Use this HTMLElement object to generate an html table tag.

Spec


Nested Class Summary
 
Nested classes/interfaces inherited from class com.plumtree.xpshared.htmlelements.HTMLElement
HTMLElement.ValidationLevel
 
Field Summary
static boolean bEnforceSummary
           
 
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
HTMLTable()
          Creates a new HTMLTable object.
 
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 GetAlign()
          Call this method to get the value of the align attribute.
 java.lang.String GetBGColor()
          Call this method to get the value of the bgcolor attribute.
 java.lang.String GetBorder()
          Call this method to get the value of the border attribute.
 java.lang.String GetBorderColor()
          Call this method to get the value of the bordercolor attribute.
 java.lang.String GetCellPadding()
          Call this method to get the value of the cellpadding attribute.
 java.lang.String GetCellSpacing()
          Call this method to get the value of the cellspacing attribute.
 java.lang.Object GetClone()
          Call this method to obtain an clone of this table.
 java.lang.String GetHeight()
          Call this method to get the value of the height attribute.
 int GetNumColsSpanned()
          Call this method to determine the number of columns spanned by this table.
 java.lang.String GetOnSelectStart()
          Call this method to get the value of the onselectstart attribute.
 java.lang.String GetSummary()
          Call this method to get the value of the summary attribute.
 java.lang.String GetWidth()
          Call this method to get the value of the width attribute.
protected  boolean ProvidesClosingTag()
          Indicates whether or not this HTML element provides a closing tag.
 void SetAlign(java.lang.String s)
          Call this method to set the align attribute value.
 void SetBGColor(java.lang.String s)
          Call this method to set the bgcolor attribute value.
 void SetBorder(java.lang.String s)
          Call this method to set the border attribute value.
 void SetBorderColor(java.lang.String s)
          Call this method to set the bordercolor attribute value.
 void SetCellPadding(java.lang.String s)
          Call this method to set the cellpadding attribute value.
 void SetCellSpacing(java.lang.String s)
          Call this method to set the cellspacing attribute value.
 void SetHeight(java.lang.String s)
          Call this method to set the height attribute value.
 void SetOnSelectStart(java.lang.String s)
          Call this method to set the onselectstart attribute value.
 void SetSummary(java.lang.String s)
          Call this method to set the summary attribute value.
 void SetWidth(java.lang.String s)
          Call this method to set the width attribute value.
 
Methods inherited from class com.plumtree.xpshared.htmlelements.HTMLElement
AddInnerHTMLEncodedString, AddInnerHTMLString, AppendClosingLineBreak, CleanupHTMLSubtreeAfterRendering, ClearInnerHTMLElements, clone, Display, Display, ForceFormattingOff, GetChildInMidRender, 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
 

Field Detail

bEnforceSummary

public static boolean bEnforceSummary
Constructor Detail

HTMLTable

public HTMLTable()
Creates a new HTMLTable object.

Method Detail

GetAlign

public java.lang.String GetAlign()
Call this method to get the value of the align attribute.

Returns:
String value.

GetBGColor

public java.lang.String GetBGColor()
Call this method to get the value of the bgcolor attribute.

Returns:
String value.

GetBorder

public java.lang.String GetBorder()
Call this method to get the value of the border attribute.

Returns:
String value.

GetBorderColor

public java.lang.String GetBorderColor()
Call this method to get the value of the bordercolor attribute.

Returns:
String value.

GetCellPadding

public java.lang.String GetCellPadding()
Call this method to get the value of the cellpadding attribute.

Returns:
String value.

GetCellSpacing

public java.lang.String GetCellSpacing()
Call this method to get the value of the cellspacing attribute.

Returns:
String value.

GetClone

public java.lang.Object GetClone()
Call this method to obtain an clone of this table.

Overrides:
GetClone in class HTMLElement
Returns:
Object that is an HTMLTable.

GetHeight

public java.lang.String GetHeight()
Call this method to get the value of the height attribute.

Returns:
String value.

GetNumColsSpanned

public int GetNumColsSpanned()
Call this method to determine the number of columns spanned by this table. This value may change if rows are added or removed.

Calling this method may be expensive, as the table needs to be evaluated to determine this information.

Returns:
Throws:
HTMLException

GetOnSelectStart

public java.lang.String GetOnSelectStart()
Call this method to get the value of the onselectstart attribute.

Returns:
String value.

GetSummary

public java.lang.String GetSummary()
Call this method to get the value of the summary attribute.

Returns:
String value.

GetWidth

public java.lang.String GetWidth()
Call this method to get the value of the width attribute.

Returns:
String value.

SetAlign

public void SetAlign(java.lang.String s)
Call this method to set the align attribute value.

Parameters:
s - String value.

SetBGColor

public void SetBGColor(java.lang.String s)
Call this method to set the bgcolor attribute value.

Parameters:
s - String value.

SetBorder

public void SetBorder(java.lang.String s)
Call this method to set the border attribute value.

Parameters:
s - String value.

SetBorderColor

public void SetBorderColor(java.lang.String s)
Call this method to set the bordercolor attribute value.

Parameters:
s - String value.

SetCellPadding

public void SetCellPadding(java.lang.String s)
Call this method to set the cellpadding attribute value.

Parameters:
s - String value.

SetCellSpacing

public void SetCellSpacing(java.lang.String s)
Call this method to set the cellspacing attribute value.

Parameters:
s - String value.

SetHeight

public void SetHeight(java.lang.String s)
Call this method to set the height attribute value.

Parameters:
s - String value.

SetOnSelectStart

public void SetOnSelectStart(java.lang.String s)
Call this method to set the onselectstart attribute value. This is IE specific, and has been added so that developers can turn off text selection in tables as this can cause problems with fancier javascript code.

Parameters:
s - String value.

SetSummary

public void SetSummary(java.lang.String s)
Call this method to set the summary attribute value.

Parameters:
s - String value.

SetWidth

public void SetWidth(java.lang.String s)
Call this method to set the width attribute value.

Parameters:
s - String value.

AddInnerHTMLElement

public void AddInnerHTMLElement(HTMLElement e)
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
Throws:
HTMLException

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.