## Class TTableCell

Description

Implements interfaces:

- IDataRenderer

TTableCell class.

TTableCell displays a table cell on a Web page. Content of the table cell is specified by the Text property. If Text is empty, the body contents enclosed by the table cell component tag are rendered. Note, Text is not HTML-encoded when displayed. So make sure it does not contain dangerous characters.

The horizontal and vertical alignments of the contents in the cell are specified via HorizontalAlign and VerticalAlign properties, respectively.

The colspan and rowspan of the cell are specified via ColumnSpan and RowSpan properties. And the Wrap property indicates whether the contents in the cell should be wrapped.

- since: 3.0
- version: $Id: TTableCell.php 1668 2007-02-04 03:30:32Z xue $
- author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TTableCell.php (line 35)

    TComponent
       |
       --TApplicationComponent
          |
          --TControl
             |
             --TWebControl
                |
                --TTableCell

Direct descendents

Class | Description
--- | ---
TTableHeaderCell | TTableHeaderCell class.

Method Summary
void addAttributesToRender (THtmlWriter $writer)
TStyle createStyle ()
integer getColumnSpan ()
string getData ()
string getHorizontalAlign ()
integer getRowSpan ()
string getTagName ()
string getText ()
string getVerticalAlign ()
boolean getWrap ()
void renderContents (THtmlWriter $writer)
void setColumnSpan (integer $value)
void setData (string $value)
void setHorizontalAlign (string $value)
void setRowSpan (integer $value)
void setText (string $value)
void setVerticalAlign (string $value)
void setWrap (boolean $value)
Methods
addAttributesToRender (line 199)

Adds attributes to renderer.

- access: protected

void addAttributesToRender (THtmlWriter $writer)

- THtmlWriter $writer: the renderer

Redefinition of:

TWebControl::addAttributesToRender()
  Adds attribute name-value pairs to renderer.

Redefined in descendants as:

- TTableHeaderCell::addAttributesToRender() : Adds attributes to renderer.

createStyle (line 50)

Creates a style object for the control.

This method creates a TTableItemStyle to be used by the table cell.

- return: control style to be used
- access: protected

TStyle createStyle ()

Redefinition of:

TWebControl::createStyle()
  Creates a style object to be used by the control.

getColumnSpan (line 100)

- return: the columnspan for the table cell, 0 if not set.
- access: public

integer getColumnSpan ()
getData (line 177)

Returns the text content of the table cell.

This method is required by IDataRenderer. It is the same as getText().

- return: the text content of the table cell.
- access: public
- since: 3.1.0
- see: TTableCell::getText()

string getData ()
getHorizontalAlign (line 58)

- return: the horizontal alignment of the contents within the table item, defaults to 'NotSet'.
- access: public

string getHorizontalAlign ()
getRowSpan (line 117)

- return: the rowspan for the table cell, 0 if not set.
- access: public

integer getRowSpan ()
getTagName (line 40)

- return: tag name for the table cell
- access: protected

string getTagName ()

Redefinition of:

TWebControl::getTagName()
  Returns the tag name used for this control.

Redefined in descendants as:

- TTableHeaderCell::getTagName()

getText (line 154)

- return: the text content of the table cell.
- access: public

string getText ()
getVerticalAlign (line 79)

- return: the vertical alignment of the contents within the table item, defaults to 'NotSet'.
- access: public

string getVerticalAlign ()
getWrap (line 134)

- return: whether the text content wraps within a table cell. Defaults to true.
- access: public

boolean getWrap ()
renderContents (line 212)

Renders body contents of the table cell.

- access: public

void renderContents (THtmlWriter $writer)

- THtmlWriter $writer: the writer used for the rendering purpose.

Redefinition of:

TWebControl::renderContents()
  Renders the body content enclosed between the control tag.

setColumnSpan (line 109)

Sets the columnspan for the table cell.

- access: public

void setColumnSpan (integer $value)

- integer $value: the columnspan for the table cell, 0 if not set.

setData (line 190)

Sets the text content of the table cell.

This method is required by IDataRenderer. It is the same as setText().

- access: public
- since: 3.1.0
- see: TTableCell::setText()

void setData (string $value)

- string $value: the text content of the table cell.

setHorizontalAlign (line 71)

Sets the horizontal alignment of the contents within the table item.

Valid values include 'NotSet', 'Justify', 'Left', 'Right', 'Center'

- access: public

void setHorizontalAlign (string $value)

- string $value: the horizontal alignment

setRowSpan (line 126)

Sets the rowspan for the table cell.

- access: public

void setRowSpan (integer $value)

- integer $value: the rowspan for the table cell, 0 if not set.

setText (line 164)

Sets the text content of the table cell.

If the text content is empty, body content (child controls) of the cell will be rendered.

- access: public

void setText (string $value)

- string $value: the text content

setVerticalAlign (line 92)

Sets the vertical alignment of the contents within the table item.

Valid values include 'NotSet','Top','Bottom','Middle'

- access: public

void setVerticalAlign (string $value)

- string $value: the horizontal alignment

setWrap (line 146)

Sets the value indicating whether the text content wraps within a table cell.

- access: public

void setWrap (boolean $value)

- boolean $value: whether the text content wraps within a table cell.

#### Inherited Methods

Inherited From TWebControl

> TWebControl::addAttributesToRender()
> TWebControl::clearStyle()
> TWebControl::copyBaseAttributes()
> TWebControl::createStyle()
> TWebControl::getAccessKey()
> TWebControl::getBackColor()
> TWebControl::getBorderColor()
> TWebControl::getBorderStyle()
> TWebControl::getBorderWidth()
> TWebControl::getCssClass()
> TWebControl::getDisplay()
> TWebControl::getFont()
> TWebControl::getForeColor()
> TWebControl::getHasStyle()
> TWebControl::getHeight()
> TWebControl::getStyle()
> TWebControl::getTabIndex()
> TWebControl::getTagName()
> TWebControl::getToolTip()
> TWebControl::getWidth()
> TWebControl::render()
> TWebControl::renderBeginTag()
> TWebControl::renderContents()
> TWebControl::renderEndTag()
> TWebControl::setAccessKey()
> TWebControl::setBackColor()
> TWebControl::setBorderColor()
> TWebControl::setBorderStyle()
> TWebControl::setBorderWidth()
> TWebControl::setCssClass()
> TWebControl::setDisplay()
> TWebControl::setForeColor()
> TWebControl::setHeight()
> TWebControl::setStyle()
> TWebControl::setTabIndex()
> TWebControl::setToolTip()
> TWebControl::setWidth()

Inherited From TControl

> TControl::__construct()
> TControl::addedControl()
> TControl::addParsedObject()
> TControl::addToPostDataLoader()
> TControl::applyStyleSheetSkin()
> TControl::autoBindProperty()
> TControl::autoDataBindProperties()
> TControl::bindProperty()
> TControl::broadcastEvent()
> TControl::bubbleEvent()
> TControl::clearChildState()
> TControl::clearControlState()
> TControl::clearNamingContainer()
> TControl::clearViewState()
> TControl::convertUniqueIdToClientId()
> TControl::createChildControls()
> TControl::createControlCollection()
> TControl::dataBind()
> TControl::dataBindChildren()
> TControl::dataBindProperties()
> TControl::ensureChildControls()
> TControl::findControl()
> TControl::findControlsByID()
> TControl::findControlsByType()
> TControl::focus()
> TControl::getAdapter()
> TControl::getAllowChildControls()
> TControl::getAttribute()
> TControl::getAttributes()
> TControl::getChildControlsCreated()
> TControl::getClientID()
> TControl::getControls()
> TControl::getControlStage()
> TControl::getControlState()
> TControl::getCustomData()
> TControl::getEnabled()
> TControl::getEnableTheming()
> TControl::getEnableViewState()
> TControl::getHasAdapter()
> TControl::getHasAttributes()
> TControl::getHasChildInitialized()
> TControl::getHasControls()
> TControl::getHasInitialized()
> TControl::getHasLoaded()
> TControl::getHasLoadedPostData()
> TControl::getHasPreRendered()
> TControl::getID()
> TControl::getNamingContainer()
> TControl::getPage()
> TControl::getParent()
> TControl::getRegisteredObject()
> TControl::getSkinID()
> TControl::getSourceTemplateControl()
> TControl::getTemplateControl()
> TControl::getUniqueID()
> TControl::getViewState()
> TControl::getVisible()
> TControl::hasAttribute()
> TControl::initRecursive()
> TControl::isDescendentOf()
> TControl::isObjectRegistered()
> TControl::loadRecursive()
> TControl::loadState()
> TControl::loadStateRecursive()
> TControl::onDataBinding()
> TControl::onInit()
> TControl::onLoad()
> TControl::onPreRender()
> TControl::onUnload()
> TControl::preRenderRecursive()
> TControl::raiseBubbleEvent()
> TControl::registerObject()
> TControl::removeAttribute()
> TControl::removedControl()
> TControl::render()
> TControl::renderChildren()
> TControl::renderControl()
> TControl::saveState()
> TControl::saveStateRecursive()
> TControl::setAdapter()
> TControl::setAttribute()
> TControl::setChildControlsCreated()
> TControl::setControlStage()
> TControl::setControlState()
> TControl::setCustomData()
> TControl::setEnabled()
> TControl::setEnableTheming()
> TControl::setEnableViewState()
> TControl::setID()
> TControl::setPage()
> TControl::setSkinID()
> TControl::setTemplateControl()
> TControl::setViewState()
> TControl::setVisible()
> TControl::trackViewState()
> TControl::traverseChildControls()
> TControl::unbindProperty()
> TControl::unloadRecursive()
> TControl::unregisterObject()
> TControl::__get()

Inherited From TApplicationComponent

> TApplicationComponent::getApplication()
> TApplicationComponent::getRequest()
> TApplicationComponent::getResponse()
> TApplicationComponent::getService()
> TApplicationComponent::getSession()
> TApplicationComponent::getUser()
> TApplicationComponent::publishAsset()
> TApplicationComponent::publishFilePath()

Inherited From TComponent

> TComponent::addParsedObject()
> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> TComponent::createdOnTemplate()
> TComponent::detachEventHandler()
> TComponent::evaluateExpression()
> TComponent::evaluateStatements()
> TComponent::getEventHandlers()
> TComponent::getSubProperty()
> TComponent::hasEvent()
> TComponent::hasEventHandler()
> TComponent::hasProperty()
> TComponent::raiseEvent()
> TComponent::setSubProperty()
> TComponent::__get()
> TComponent::__set()

Class Constants

#### Inherited Constants

Inherited from TControl

> TControl::AUTOMATIC_ID_PREFIX
> TControl::CLIENT_ID_SEPARATOR
> TControl::CS_CHILD_INITIALIZED
> TControl::CS_CONSTRUCTED
> TControl::CS_INITIALIZED
> TControl::CS_LOADED
> TControl::CS_PRERENDERED
> TControl::CS_STATE_LOADED
> TControl::ID_FORMAT
> TControl::ID_SEPARATOR
> TControl::IS_CHILD_CREATED
> TControl::IS_CREATING_CHILD
> TControl::IS_DISABLE_THEMING
> TControl::IS_DISABLE_VIEWSTATE
> TControl::IS_ID_SET
> TControl::IS_SKIN_APPLIED
> TControl::IS_STYLESHEET_APPLIED
> TControl::RF_ADAPTER
> TControl::RF_AUTO_BINDINGS
> TControl::RF_CHILD_STATE
> TControl::RF_CONTROLS
> TControl::RF_CONTROLSTATE
> TControl::RF_DATA_BINDINGS
> TControl::RF_EVENTS
> TControl::RF_NAMED_CONTROLS
> TControl::RF_NAMED_CONTROLS_ID
> TControl::RF_NAMED_OBJECTS
> TControl::RF_SKIN_ID

Documentation generated on Mon, 21 Apr 2008 11:36:24 -0400 by phpDocumentor 1.3.0RC4