## Class TBaseDataList

Description

TBaseDataList class

TBaseDataList is the base class for data listing controls, including TDataList and TDataGrid.

The key field in the data source is specified by setKeyField, while getKeyValues stores the key values of each record in a data listing control. You may use the list item index to obtain the corresponding database key value.

TBaseDataList also implements a few properties used for presentation based on tabular layout. The Caption, whose alignment is specified via CaptionAlign, is rendered as the table caption. The table cellpadding and cellspacing are specified by CellPadding and CellSpacing properties, respectively. The GridLines specifies how the table should display its borders, and the horizontal alignment of the table content can be specified via HorizontalAlign.

- abstract:
- since: 3.0
- version: $Revision: $ $Date: $
- author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TBaseDataList.php (line 44)

    TComponent
       |
       --TApplicationComponent
          |
          --TControl
             |
             --TWebControl
                |
                --TDataBoundControl
                   |
                   --TBaseDataList

Direct descendents

Class | Description
--- | ---
TDataGrid | TDataGrid class
TDataList | TDataList class

Method Summary
void addParsedObject (mixed $object)
TTableStyle createStyle ()
string getCaption ()
string getCaptionAlign ()
integer getCellPadding ()
integer getCellSpacing ()
mixed getDataFieldValue (mixed $data, mixed $field)
string getDataKeyField ()
TList getDataKeys ()
string getGridLines ()
string getHorizontalAlign ()
void onSelectedIndexChanged (mixed $param)
void setCaption (string $value)
string setCaptionAlign (mixed $value)
void setCellPadding (integer $value)
void setCellSpacing (integer $value)
void setDataKeyField (string $value)
void setGridLines (string $value)
void setHorizontalAlign (string $value)
Methods
addParsedObject (line 51)

No body content should be added to data list control.

This method is invoked when body content is parsed and added to this control.

- access: public

void addParsedObject (mixed $object)

- mixed $object: body content to be added

Redefinition of:

TControl::addParsedObject()
  Processes an object that is created during parsing template.

Redefined in descendants as:

- TDataGrid::addParsedObject() : Adds objects parsed in template to datagrid.

createStyle (line 60)

Creates a style object for the control.

This method creates a TTableStyle to be used by the data list control.

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

TTableStyle createStyle ()

Redefinition of:

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

Redefined in descendants as:

- TDataGrid::createStyle() : Creates a style object for the control.

getCaption (line 68)

- return: caption of the table layout
- access: public

string getCaption ()

Redefined in descendants as:

- TDataList::getCaption()

getCaptionAlign (line 84)

- return: alignment of the caption of the table layout. Defaults to 'NotSet'.
- access: public

string getCaptionAlign ()

Redefined in descendants as:

- TDataList::getCaptionAlign()

getCellPadding (line 120)

- return: the cellpadding for the table layout. Defaults to -1, meaning not set.
- access: public

integer getCellPadding ()
getCellSpacing (line 101)

- return: the cellspacing for the table layout. Defaults to -1, meaning not set.
- access: public

integer getCellSpacing ()
getDataFieldValue (line 218)

Returns the value of the data at the specified field.

If data is an array, TMap or TList, the value will be returned at the index of the specified field. If the data is a component with a property named as the field name, the property value will be returned. Otherwise, an exception will be raised.

- return: data value at the specified field
- access: protected
- throws: TInvalidDataValueException if the data is invalid

mixed getDataFieldValue (mixed $data, mixed $field)

- mixed $data: data item
- mixed $field: field name

getDataKeyField (line 181)

- return: the field of the data source that provides the keys of the list items.
- access: public

string getDataKeyField ()
getDataKeys (line 197)

- return: the keys used in the data listing control.
- access: public

TList getDataKeys ()
getGridLines (line 159)

- return: the grid line setting of the table layout. Defaults to 'None'.
- access: public

string getGridLines ()
getHorizontalAlign (line 139)

- return: the horizontal alignment of the table content. Defaults to 'NotSet'.
- access: public

string getHorizontalAlign ()
onSelectedIndexChanged (line 229)

Raises OnSelectedIndexChanged event.

This method is invoked when a different item is selected in a data listing control between posts to the server.

- access: public

void onSelectedIndexChanged (mixed $param)

- mixed $param: event parameter

setCaption (line 76)

- access: public

void setCaption (string $value)

- string $value: caption of the table layout

Redefined in descendants as:

- TDataList::setCaption()

setCaptionAlign (line 93)

- return: alignment of the caption of the table layout. Valid values include 'NotSet','Top','Bottom','Left','Right'.
- access: public

string setCaptionAlign (mixed $value)

Redefined in descendants as:

- TDataList::setCaptionAlign()

setCellPadding (line 131)

- access: public

void setCellPadding (integer $value)

- integer $value: the cellpadding for the table layout

setCellSpacing (line 112)

- access: public

void setCellSpacing (integer $value)

- integer $value: the cellspacing for the table layout.

setDataKeyField (line 189)

- access: public

void setDataKeyField (string $value)

- string $value: the field of the data source that provides the keys of the list items.

setGridLines (line 172)

Sets the grid line style of the table layout.

Valid values include 'None', 'Horizontal', 'Vertical', 'Both'.

- access: public

void setGridLines (string $value)

- string $value: the grid line setting of the table

setHorizontalAlign (line 151)

- access: public

void setHorizontalAlign (string $value)

- string $value: the horizontal alignment of the table content. Valid values include 'NotSet', 'Justify', 'Left', 'Right', 'Center'.

#### Inherited Methods

Inherited From TDataBoundControl

> TDataBoundControl::dataBind()
> TDataBoundControl::dataSourceViewChanged()
> TDataBoundControl::determineDataSource()
> TDataBoundControl::ensureDataBound()
> TDataBoundControl::getData()
> TDataBoundControl::getDataMember()
> TDataBoundControl::getDataSource()
> TDataBoundControl::getDataSourceID()
> TDataBoundControl::getDataSourceView()
> TDataBoundControl::getInitialized()
> TDataBoundControl::getIsDataBound()
> TDataBoundControl::getRequiresDataBinding()
> TDataBoundControl::getSelectParameters()
> TDataBoundControl::getUsingDataSourceID()
> TDataBoundControl::onDataBound()
> TDataBoundControl::onDataSourceChanged()
> TDataBoundControl::onInit()
> TDataBoundControl::onPagePreLoad()
> TDataBoundControl::onPreRender()
> TDataBoundControl::performDataBinding()
> TDataBoundControl::setDataMember()
> TDataBoundControl::setDataSource()
> TDataBoundControl::setDataSourceID()
> TDataBoundControl::setInitialized()
> TDataBoundControl::setIsDataBound()
> TDataBoundControl::setRequiresDataBinding()
> TDataBoundControl::validateDataSource()

Inherited From TWebControl

> TWebControl::addAttributesToRender()
> TWebControl::copyBaseAttributes()
> TWebControl::createStyle()
> TWebControl::getAccessKey()
> TWebControl::getBackColor()
> TWebControl::getBorderColor()
> TWebControl::getBorderStyle()
> TWebControl::getBorderWidth()
> TWebControl::getCssClass()
> 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::setForeColor()
> TWebControl::setHeight()
> TWebControl::setStyle()
> TWebControl::setTabIndex()
> TWebControl::setToolTip()
> TWebControl::setWidth()

Inherited From TControl

> TControl::__construct()
> TControl::addedControl()
> TControl::addParsedObject()
> TControl::applyStyleSheetSkin()
> TControl::autoBindProperty()
> TControl::autoDataBindProperties()
> TControl::bindProperty()
> TControl::broadcastEvent()
> TControl::broadcastEventInternal()
> TControl::clearChildState()
> TControl::clearControlState()
> TControl::clearNamingContainer()
> TControl::clearViewState()
> TControl::createChildControls()
> TControl::createControlCollection()
> TControl::createdOnTemplate()
> 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::getEnabled()
> TControl::getEnableTheming()
> TControl::getEnableViewState()
> TControl::getHasAdapter()
> TControl::getHasAttributes()
> TControl::getHasControls()
> 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::onBubbleEvent()
> 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::setEnabled()
> TControl::setEnableTheming()
> TControl::setEnableViewState()
> TControl::setID()
> TControl::setPage()
> TControl::setSkinID()
> TControl::setTemplateControl()
> TControl::setViewState()
> TControl::setVisible()
> 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::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> 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

Documentation generated on Mon, 01 May 2006 23:02:46 -0400 by phpDocumentor 1.3.0RC4