com.plumtree.xpshared.htmlelements
Class HTMLTableCell

java.lang.Object
  extended by com.plumtree.xpshared.htmlelements.HTMLElement
      extended by com.plumtree.xpshared.htmlelements.HTMLTableCell
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
HTMLTableHeader

public class HTMLTableCell
extends HTMLElement

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
HTMLTableCell()
          Creates a new HTMLTableCell object.
HTMLTableCell(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 HTMLCell 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 HTMLTableCell is an autofit cell.
 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

HTMLTableCell

public HTMLTableCell(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 HTMLTableCell object.

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


HTMLTableCell

public HTMLTableCell()
Creates a new HTMLTableCell object.

Method Detail

GetAlign

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

Returns:
String value

GetAutoFit

public boolean GetAutoFit()
Call this method to determine whether or not this HTMLCell object will automatically span the number of columns necessary.

Returns:

GetBGColor

public java.lang.String GetBGColor()
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.

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.

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.

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.

Returns:
int value.

GetHeaders

public java.lang.String GetHeaders()
Returns:

GetHeight

public java.lang.String GetHeight()
Returns:

GetNoWrap

public boolean GetNoWrap()
Returns:

GetVAlign

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

Returns:
String value

GetWidth

public java.lang.String GetWidth()
Returns:

SetAlign

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

Parameters:
s - String value

SetAutoFit

public void SetAutoFit(boolean b)
Call this method to toggle whether or not this HTMLTableCell is an autofit cell. An autofit cell 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 cell. This check is executed at display time, and an HTMLException will be thrown if there are multiple autofit cells within a given row. Note that autofit does not apply to rowspan, which must be set manually.

Parameters:
b -

SetBGColor

public void SetBGColor(java.lang.String s)
Parameters:
s -

SetColSpan

public void SetColSpan(java.lang.String s)
Call this method to set the value of the colspan attribute.

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.

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.

Parameters:
s - String value.

SetHeight

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

Parameters:
s - String value.

SetNoWrap

public void SetNoWrap(boolean b)
Call this method to toggle the nowrap attribute.

Parameters:
b - value

SetVAlign

public void SetVAlign(java.lang.String s)
Call this method to set the value of the valign attribute.

Parameters:
s - String value

SetWidth

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

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.

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.