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 setCaption, whose alignment is specified via setCaptionAlign, 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: $Id: TBaseDataList.php 1398 2006-09-08 19:31:03Z xue $
  • 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
integer getCellPadding ()
integer getCellSpacing ()
mixed getDataFieldValue (mixed $data, mixed $field)
string getDataKeyField ()
void onSelectedIndexChanged (mixed $param)
void setCellPadding (integer $value)
void setCellSpacing (integer $value)
void setDataKeyField (string $value)
void setGridLines (TTableGridLines $value)
Methods
createStyle (line 51)

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:
getCellPadding (line 78)
  • return: the cellpadding for the table layout. Defaults to -1, meaning not set.
  • access: public
integer getCellPadding ()
getCellSpacing (line 59)
  • return: the cellspacing for the table layout. Defaults to -1, meaning not set.
  • access: public
integer getCellSpacing ()
getDataFieldValue (line 174)

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 137)
  • return: the field of the data source that provides the keys of the list items.
  • access: public
string getDataKeyField ()
getDataKeys (line 153)
  • return: the keys used in the data listing control.
  • access: public
TList getDataKeys ()
getGridLines (line 116)
  • return: the grid line setting of the table layout. Defaults to TTableGridLines::None.
  • access: public
TTableGridLines getGridLines ()
getHorizontalAlign (line 97)
  • return: the horizontal alignment of the table content. Defaults to THorizontalAlign::NotSet.
  • access: public
THorizontalAlign getHorizontalAlign ()
onSelectedIndexChanged (line 185)

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
setCellPadding (line 89)
  • access: public
void setCellPadding (integer $value)
  • integer $value: the cellpadding for the table layout
setCellSpacing (line 70)
  • access: public
void setCellSpacing (integer $value)
  • integer $value: the cellspacing for the table layout.
setDataKeyField (line 145)
  • access: public
void setDataKeyField (string $value)
  • string $value: the field of the data source that provides the keys of the list items.
setGridLines (line 128)

Sets the grid line style of the table layout.

  • access: public
void setGridLines (TTableGridLines $value)
setHorizontalAlign (line 108)
  • access: public
void setHorizontalAlign (THorizontalAlign $value)

Inherited Methods

Inherited From TDataBoundControl

TDataBoundControl::createPagedDataSource()
TDataBoundControl::dataBind()
TDataBoundControl::dataSourceViewChanged()
TDataBoundControl::determineDataSource()
TDataBoundControl::ensureDataBound()
TDataBoundControl::getAllowCustomPaging()
TDataBoundControl::getAllowPaging()
TDataBoundControl::getCurrentPageIndex()
TDataBoundControl::getDataMember()
TDataBoundControl::getDataSource()
TDataBoundControl::getDataSourceID()
TDataBoundControl::getDataSourceView()
TDataBoundControl::getInitialized()
TDataBoundControl::getIsDataBound()
TDataBoundControl::getPageCount()
TDataBoundControl::getPageSize()
TDataBoundControl::getRequiresDataBinding()
TDataBoundControl::getSelectParameters()
TDataBoundControl::getUsingDataSourceID()
TDataBoundControl::getVirtualItemCount()
TDataBoundControl::onDataBound()
TDataBoundControl::onDataSourceChanged()
TDataBoundControl::onInit()
TDataBoundControl::onPreRender()
TDataBoundControl::pagePreLoad()
TDataBoundControl::performDataBinding()
TDataBoundControl::setAllowCustomPaging()
TDataBoundControl::setAllowPaging()
TDataBoundControl::setCurrentPageIndex()
TDataBoundControl::setDataMember()
TDataBoundControl::setDataSource()
TDataBoundControl::setDataSourceID()
TDataBoundControl::setInitialized()
TDataBoundControl::setIsDataBound()
TDataBoundControl::setPageSize()
TDataBoundControl::setRequiresDataBinding()
TDataBoundControl::setVirtualItemCount()
TDataBoundControl::validateDataSource()

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

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