Class TBaseDataList
Direct Known Sub-classes:
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.
Constants Inherited From TControl |
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID,
|
Method Summary |
protected
TTableStyle
|
Creates a style object for the control.
|
integer
|
|
integer
|
|
protected
mixed
|
Returns the value of the data at the specified field.
|
string
|
|
TList
|
|
TTableGridLines
|
|
THorizontalAlign
|
|
void
|
Raises OnSelectedIndexChanged event.
|
void
|
|
void
|
|
void
|
|
void
|
Sets the grid line style of the table layout.
|
void
|
|
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::setAllowCustomPaging(), TDataBoundControl::setAllowPaging(), TDataBoundControl::setCurrentPageIndex(), TDataBoundControl::setDataMember(), TDataBoundControl::setDataSource(), TDataBoundControl::setDataSourceID(), TDataBoundControl::setInitialized(), TDataBoundControl::setIsDataBound(), TDataBoundControl::setPageSize(), TDataBoundControl::setRequiresDataBinding(), TDataBoundControl::setVirtualItemCount(), TDataBoundControl::validateDataSource()
|
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()
|
Methods Inherited From TControl |
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()
|
Methods 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()
|
Method Details |
createStyle
Creates a style object for the control.
This method creates a TTableStyle to be used by the data list control.
|
getCellPadding
public integer getCellPadding |
() |
Output |
integer
| the cellpadding for the table layout. Defaults to -1, meaning not set. |
Exception |
|
getCellSpacing
public integer getCellSpacing |
() |
Output |
integer
| the cellspacing for the table layout. Defaults to -1, meaning not set. |
Exception |
|
getDataFieldValue
protected mixed getDataFieldValue |
(mixed $data , mixed $field ) |
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.
Input |
mixed | $data | data item |
mixed | $field | field name |
Output |
mixed
| data value at the specified field |
Exception |
throws | TInvalidDataValueException if the data is invalid |
|
getDataKeyField
public string getDataKeyField |
() |
Output |
string
| the field of the data source that provides the keys of the list items. |
Exception |
|
getDataKeys
public TList getDataKeys |
() |
Output |
TList
| the keys used in the data listing control. |
Exception |
|
getGridLines
Output |
TTableGridLines
| the grid line setting of the table layout. Defaults to TTableGridLines::None. |
Exception |
|
getHorizontalAlign
Output |
THorizontalAlign
| the horizontal alignment of the table content. Defaults to THorizontalAlign::NotSet. |
Exception |
|
onSelectedIndexChanged
public void onSelectedIndexChanged |
(mixed $param ) |
Raises OnSelectedIndexChanged event.
This method is invoked when a different item is selected in a data listing control between posts to the server.
Input |
mixed | $param | event parameter |
Output |
Exception |
|
setCellPadding
public void setCellPadding |
(integer $value ) |
Input |
integer | $value | the cellpadding for the table layout |
Output |
Exception |
|
setCellSpacing
public void setCellSpacing |
(integer $value ) |
Input |
integer | $value | the cellspacing for the table layout. |
Output |
Exception |
|
setDataKeyField
public void setDataKeyField |
(string $value ) |
Input |
string | $value | the field of the data source that provides the keys of the list items. |
Output |
Exception |
|
setGridLines
Sets the grid line style of the table layout.
Input |
TTableGridLines | $value | the grid line setting of the table |
Output |
Exception |
|
setHorizontalAlign
Input |
THorizontalAlign | $value | the horizontal alignment of the table content. |
Output |
Exception |
|
|