Class TActiveDataList

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

TActiveDataList class

TActiveDataList represents a data bound and updatable grid control which is the active counterpart to the original TDataList control.

This component can be used in the same way as the regular datalist, the only difference is that the active datalist uses callbacks instead of postbacks for interaction.

Please refer to the original documentation of the regular counterparts for usage.

Constants Inherited From TDataList
CMD_CANCEL, CMD_DELETE, CMD_EDIT, CMD_SELECT, CMD_UPDATE,

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,

Constructor Summary
public	__construct Creates a new callback control, sets the adapter to TActiveControlAdapter.

Method Summary
TBaseActiveControl	getActiveControl ()
protected string	getContainerID () Returns the id of the surrounding container (span).
void	render ( THtmlWriter $writer) Renders the repeater.
void	setDataSource ( Traversable\|array\|string $value) Sets the data source object associated with the repeater control.

Methods Inherited From TDataList

TDataList::applyItemStyles(), TDataList::bubbleEvent(), TDataList::createEmptyContent(), TDataList::createItem(), TDataList::generateItemStyle(), TDataList::getAlternatingItemRenderer(), TDataList::getAlternatingItemStyle(), TDataList::getAlternatingItemTemplate(), TDataList::getCaption(), TDataList::getCaptionAlign(), TDataList::getEditItem(), TDataList::getEditItemIndex(), TDataList::getEditItemRenderer(), TDataList::getEditItemStyle(), TDataList::getEditItemTemplate(), TDataList::getEmptyRenderer(), TDataList::getEmptyTemplate(), TDataList::getFooter(), TDataList::getFooterRenderer(), TDataList::getFooterStyle(), TDataList::getFooterTemplate(), TDataList::getHasFooter(), TDataList::getHasHeader(), TDataList::getHasSeparators(), TDataList::getHeader(), TDataList::getHeaderRenderer(), TDataList::getHeaderStyle(), TDataList::getHeaderTemplate(), TDataList::getItemCount(), TDataList::getItemRenderer(), TDataList::getItems(), TDataList::getItemStyle(), TDataList::getItemTemplate(), TDataList::getRepeatColumns(), TDataList::getRepeatDirection(), TDataList::getRepeatInfo(), TDataList::getRepeatLayout(), TDataList::getSelectedDataKey(), TDataList::getSelectedItem(), TDataList::getSelectedItemIndex(), TDataList::getSelectedItemRenderer(), TDataList::getSelectedItemStyle(), TDataList::getSelectedItemTemplate(), TDataList::getSeparatorRenderer(), TDataList::getSeparatorStyle(), TDataList::getSeparatorTemplate(), TDataList::getShowFooter(), TDataList::getShowHeader(), TDataList::loadState(), TDataList::onCancelCommand(), TDataList::onDeleteCommand(), TDataList::onEditCommand(), TDataList::onItemCommand(), TDataList::onItemCreated(), TDataList::onItemDataBound(), TDataList::onUpdateCommand(), TDataList::performDataBinding(), TDataList::render(), TDataList::renderItem(), TDataList::reset(), TDataList::restoreItemsFromViewState(), TDataList::saveState(), TDataList::setAlternatingItemRenderer(), TDataList::setAlternatingItemTemplate(), TDataList::setCaption(), TDataList::setCaptionAlign(), TDataList::setEditItemIndex(), TDataList::setEditItemRenderer(), TDataList::setEditItemTemplate(), TDataList::setEmptyRenderer(), TDataList::setEmptyTemplate(), TDataList::setFooterRenderer(), TDataList::setFooterTemplate(), TDataList::setHeaderRenderer(), TDataList::setHeaderTemplate(), TDataList::setItemRenderer(), TDataList::setItemTemplate(), TDataList::setRepeatColumns(), TDataList::setRepeatDirection(), TDataList::setRepeatLayout(), TDataList::setSelectedItemIndex(), TDataList::setSelectedItemRenderer(), TDataList::setSelectedItemTemplate(), TDataList::setSeparatorRenderer(), TDataList::setSeparatorTemplate(), TDataList::setShowFooter(), TDataList::setShowHeader()

Methods Inherited From TBaseDataList

TBaseDataList::createStyle(), TBaseDataList::getCellPadding(), TBaseDataList::getCellSpacing(), TBaseDataList::getDataFieldValue(), TBaseDataList::getDataKeyField(), TBaseDataList::getDataKeys(), TBaseDataList::getGridLines(), TBaseDataList::getHorizontalAlign(), TBaseDataList::onSelectedIndexChanged(), TBaseDataList::setCellPadding(), TBaseDataList::setCellSpacing(), TBaseDataList::setDataKeyField(), TBaseDataList::setGridLines(), TBaseDataList::setHorizontalAlign()

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 TApplicationComponent
TApplicationComponent::getApplication(), TApplicationComponent::getRequest(), TApplicationComponent::getResponse(), TApplicationComponent::getService(), TApplicationComponent::getSession(), TApplicationComponent::getUser(), TApplicationComponent::publishAsset(), TApplicationComponent::publishFilePath()

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()

Constant Summary

Constructor Details

__construct

public __construct

Creates a new callback control, sets the adapter to TActiveControlAdapter.

Method Details

getActiveControl

public TBaseActiveControl getActiveControl

()

Output
TBaseActiveControl	standard active control options.
Exception

getContainerID

protected string getContainerID

()

Returns the id of the surrounding container (span).

Output
string	container id
Exception

render

public void render

(THtmlWriter $writer )

Renders the repeater.

If the repeater did not pass the prerender phase yet, it will register itself for rendering later. Else it will call the renderRepeater() method which will do the rendering of the repeater.

Input
THtmlWriter	$writer	writer for the rendering purpose
Output
Exception

setDataSource

public void setDataSource

(Traversable|array|string $value )

Sets the data source object associated with the repeater control.

In addition, the render method of all connected pagers is called so they get updated when the data source is changed. Also the repeater registers itself for rendering in order to get it's content replaced on client side.

Input
Traversable\|array\|string	$value	data source object
Output
Exception