com.plumtree.xpshared.htmlelements
Class HTMLTableHeader

java.lang.Object
  com.plumtree.xpshared.htmlelements.HTMLElement
      com.plumtree.xpshared.htmlelements.HTMLTableCell
          com.plumtree.xpshared.htmlelements.HTMLTableHeader

All Implemented Interfaces:

java.lang.Cloneable

public class HTMLTableHeader
extends HTMLTableCell

Use this object to generate a <td></td> tag.

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

HTMLTableHeader()
Creates a new HTMLTableHeader object.

HTMLTableHeader(HTMLTableRow rParent)
Deprecated. It's no longer necessary to pass the parent row, use constructor with no parameters.

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	GetAlign() Call this method to get the value of the align attribute.
boolean	GetAutoFit() Call this method to determine whether or not this HTMLHeader object will automatically span the number of columns necessary.
java.lang.String	GetBGColor()
java.lang.String	GetColSpan() Call this method to get the value of the colspan attribute.
int	GetColSpanAsInt() Call this method to get the value of the colspan attribute.
java.lang.String	GetHeaders()
java.lang.String	GetHeight()
boolean	GetNoWrap()
java.lang.String	GetRowSpan() Call this method to get the value of the rowspan attribute.
int	GetRowSpanAsInt() Call this method to get the value of the rowspan attribute.
java.lang.String	GetVAlign() Call this method to get the value of the valign attribute.
java.lang.String	GetWidth()
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	SetAutoFit(boolean b) Call this method to toggle whether or not this HTMLTableHeader is an autofit header.
void	SetBGColor(java.lang.String s)
void	SetColSpan(java.lang.String s) Call this method to set the value of the colspan attribute.
void	SetHeaders(java.lang.String s) Call this method to set the value of the headers attribute.
void	SetHeight(java.lang.String s) Call this method to set the value of the height attribute.
void	SetNoWrap(boolean b) Call this method to toggle the nowrap attribute.
void	SetRowSpan(java.lang.String s) Call this method to set the value of the rowspan attribute.
void	SetVAlign(java.lang.String s) Call this method to set the value of the valign attribute.
void	SetWidth(java.lang.String s) Call this method to set the value of the width attribute.

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, 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

HTMLTableHeader

public HTMLTableHeader(HTMLTableRow rParent)

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

Call this method to create a new HTMLTableHeader object.

Parameters:

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

HTMLTableHeader

public HTMLTableHeader()

Creates a new HTMLTableHeader object.

Method Detail

GetAlign

public java.lang.String GetAlign()

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

Overrides:

GetAlign in class HTMLTableCell

Returns:

String value

GetAutoFit

public boolean GetAutoFit()

Call this method to determine whether or not this HTMLHeader object will automatically span the number of columns necessary.

Overrides:

GetAutoFit in class HTMLTableCell

Returns:

GetBGColor

public java.lang.String GetBGColor()

Overrides:

GetBGColor in class HTMLTableCell

Returns:

GetColSpan

public java.lang.String GetColSpan()

Call this method to get the value of the colspan attribute. This value is calculated at display time.

Overrides:

GetColSpan in class HTMLTableCell

Returns:

String value.

GetRowSpan

public java.lang.String GetRowSpan()

Call this method to get the value of the rowspan attribute. This value is calculated at display time.

Overrides:

GetRowSpan in class HTMLTableCell

Returns:

String value.

GetColSpanAsInt

public int GetColSpanAsInt()

Call this method to get the value of the colspan attribute. This value is calculated at display time.

Overrides:

GetColSpanAsInt in class HTMLTableCell

Returns:

int value.

GetRowSpanAsInt

public int GetRowSpanAsInt()

Call this method to get the value of the rowspan attribute. This value is calculated at display time.

Overrides:

GetRowSpanAsInt in class HTMLTableCell

Returns:

int value.

GetHeaders

public java.lang.String GetHeaders()

Overrides:

GetHeaders in class HTMLTableCell

Returns:

GetHeight

public java.lang.String GetHeight()

Overrides:

GetHeight in class HTMLTableCell

Returns:

GetNoWrap

public boolean GetNoWrap()

Overrides:

GetNoWrap in class HTMLTableCell

Returns:

GetVAlign

public java.lang.String GetVAlign()

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

Overrides:

GetVAlign in class HTMLTableCell

Returns:

String value

GetWidth

public java.lang.String GetWidth()

Overrides:

GetWidth in class HTMLTableCell

Returns:

SetAlign

public void SetAlign(java.lang.String s)

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

Overrides:

SetAlign in class HTMLTableCell

Parameters:

s - String value

SetAutoFit

public void SetAutoFit(boolean b)

Call this method to toggle whether or not this HTMLTableHeader is an autofit header. An autofit header will take up as many columns as is necessary to complete the row within which it resides. When asked to display, a given HTMLTableRow may only have one single autofit header. This check is executed at display time, and an HTMLException will be thrown if there are multiple autofit headers within a given row. Note that autofit does not apply to rowspan, which must be set manually.

Overrides:

SetAutoFit in class HTMLTableCell

Parameters:

b -

SetBGColor

public void SetBGColor(java.lang.String s)

Overrides:

SetBGColor in class HTMLTableCell

Parameters:

s -

SetColSpan

public void SetColSpan(java.lang.String s)

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

Overrides:

SetColSpan in class HTMLTableCell

Parameters:

s - String value.

Throws:

HTMLException

SetRowSpan

public void SetRowSpan(java.lang.String s)

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

Overrides:

SetRowSpan in class HTMLTableCell

Parameters:

s - String value.

Throws:

HTMLException

SetHeaders

public void SetHeaders(java.lang.String s)

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

Overrides:

SetHeaders in class HTMLTableCell

Parameters:

s - String value.

SetHeight

public void SetHeight(java.lang.String s)

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

Overrides:

SetHeight in class HTMLTableCell

Parameters:

s - String value.

SetNoWrap

public void SetNoWrap(boolean b)

Call this method to toggle the nowrap attribute.

Overrides:

SetNoWrap in class HTMLTableCell

Parameters:

b - value

SetVAlign

public void SetVAlign(java.lang.String s)

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

Overrides:

SetVAlign in class HTMLTableCell

Parameters:

s - String value

SetWidth

public void SetWidth(java.lang.String s)

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

Overrides:

SetWidth in class HTMLTableCell

Parameters:

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

Overrides:

AppendBeginningOfOpeningTag in class HTMLTableCell

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.

Overrides:

AppendClosingTag in class HTMLTableCell

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.

Overrides:

ProvidesClosingTag in class HTMLTableCell

Returns:

boolean true.