com.plumtree.xpshared.htmlelements
Class HTMLTableRow

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

All Implemented Interfaces:

java.lang.Cloneable

public class HTMLTableRow
extends HTMLElement

This class can be used to generate html elements.

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

HTMLTableRow()
Creates a new HTMLTableRow object.

HTMLTableRow(HTMLTable tParent)
Deprecated. It's no longer necessary to pass the parent table, use constructor with no parameters.

Method Summary

void	AddInnerHTMLElement(HTMLElement e) Call this method to add an HTMLTableCell to this HTMLTableRow.
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 obtain the value of the align attribute.
java.lang.String	GetBGColor() Call this method to obtain the value of the bgcolor attribute.
java.lang.String	GetBorderColor() Call this method to obtain the value of the bordercolor attribute.
java.lang.Object	GetClone() Call this method to obtain an clone of this table row.
boolean	GetHasAutoFitElement() Call this method to determine whether or not this HTMLTableRow has any autofit cells.
int	GetNumColsSpanned() This method returns the number of columns spanned by all of the cells in this row.
HTMLTable	GetParentTable() Call this method to obtain a reference to the HTMLTable to which this HTMLTableRow may be added.
java.lang.String	GetVAlign() Call this method to obtain the value of the valign 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 value of the align attribute.
void	SetBGColor(java.lang.String s) Call this method to set the value of the bgcolor attribute.
void	SetBorderColor(java.lang.String s) Call this method to set the value of the bordercolor attribute.
void	SetVAlign(java.lang.String s) Call this method to set the value of the valign attribute.

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

Constructor Detail

HTMLTableRow

public HTMLTableRow(HTMLTable tParent)

Deprecated. It's no longer necessary to pass the parent table, use constructor with no parameters.

Call this method to create a new HTMLTableRow object.

Parameters:

tParent - Pass the HTMLTable to which this HTMLTableRow will be added. A given instance of an HTMLTableRow may only be added to the HTMLTable specified to this constructor.

HTMLTableRow

public HTMLTableRow()

Creates a new HTMLTableRow object.

Method Detail

GetClone

public java.lang.Object GetClone()

Call this method to obtain an clone of this table row.

Overrides:

GetClone in class HTMLElement

Returns:

Object that is an HTMLTableRow.

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.

GetParentTable

public HTMLTable GetParentTable()

Call this method to obtain a reference to the HTMLTable to which this HTMLTableRow may be added.

GetHasAutoFitElement

public boolean GetHasAutoFitElement()

Call this method to determine whether or not this HTMLTableRow has any autofit cells.

SetAlign

public void SetAlign(java.lang.String s)

Call this method to set the value of the align attribute.

Parameters:

s - String value

GetAlign

public java.lang.String GetAlign()

Call this method to obtain the value of the align attribute.

Returns:

String value

SetBGColor

public void SetBGColor(java.lang.String s)

Call this method to set the value of the bgcolor attribute.

Parameters:

s - String value

GetBGColor

public java.lang.String GetBGColor()

Call this method to obtain the value of the bgcolor attribute.

Returns:

String value

SetBorderColor

public void SetBorderColor(java.lang.String s)

Call this method to set the value of the bordercolor attribute.

Parameters:

s - String value

GetBorderColor

public java.lang.String GetBorderColor()

Call this method to obtain the value of the bordercolor attribute.

Returns:

String value

SetVAlign

public void SetVAlign(java.lang.String s)

Call this method to set the value of the valign attribute.

Parameters:

s - String value

GetVAlign

public java.lang.String GetVAlign()

Call this method to obtain the value of the valign attribute.

Returns:

String value

GetNumColsSpanned

public int GetNumColsSpanned()

This method returns the number of columns spanned by all of the cells in this row. An AutoFit cell, if present, is assumed to span 1 column.

Returns:

Throws:

HTMLException

AddInnerHTMLElement

public void AddInnerHTMLElement(HTMLElement e)

Call this method to add an HTMLTableCell to this HTMLTableRow. The HTMLTableCell being added to this row must have been constructed with a reference to this particular HTMLTableRow. In this way, a given instance of an HTMLTableCell "belongs" to a given instance of an HTMLTableRow.

Overrides:

AddInnerHTMLElement in class HTMLElement