Class TActiveDataGrid

Description

Implements interfaces:

TActiveDataGrid class

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

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

There are also active datagrid columns to work with the TActiveDataGrid, which are

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

Located in /Web/UI/ActiveControls/TActiveDataGrid.php (line 54)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TDataBoundControl
               |
               --TBaseDataList
                  |
                  --TDataGrid
                     |
                     --TActiveDataGrid
Method Summary
TActiveDataGrid __construct ()
mixed createPagerButton (string $buttonType, boolean $enabled, string $text, string $commandName, string $commandParameter)
void render (THtmlWriter $writer)
void setDataSource (Traversable|array|string $value)
Variables

Inherited Variables

Inherited from TWebControl

TWebControl::$_decorator
Methods
Constructor __construct (line 68)

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

  • access: public
TActiveDataGrid __construct ()

Redefinition of:
TControl::__construct()
Constructor.
createPagerButton (line 116)

Creates a pager button.

Depending on the button type, a TActiveLinkButton or a TActiveButton may be created. If it is enabled (clickable), its command name and parameter will also be set. It overrides the datagrid's original method to create active controls instead, thus the pager will do callbacks instead of the regular postbacks.

  • return: the button instance
  • access: protected
mixed createPagerButton (string $buttonType, boolean $enabled, string $text, string $commandName, string $commandParameter)
  • string $buttonType: button type, either LinkButton or PushButton
  • boolean $enabled: whether the button should be enabled
  • string $text: caption of the button
  • string $commandName: CommandName corresponding to the OnCommand event of the button
  • string $commandParameter: CommandParameter corresponding to the OnCommand event of the button

Redefinition of:
TDataGrid::createPagerButton()
Creates a pager button.
getActiveControl (line 76)
  • return: standard active control options.
  • access: public
TBaseActiveControl getActiveControl ()
getAutoGenerateColumnName (line 59)
  • return: Name of the class used in AutoGenerateColumns mode
  • access: protected
string getAutoGenerateColumnName ()

Redefinition of:
TDataGrid::getAutoGenerateColumnName()
getSurroundingTagId (line 99)

Returns the id of the surrounding container (div).

  • return: container id
  • access: public
string getSurroundingTagId ()
render (line 144)

Renders the datagrid.

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

  • access: public
void render (THtmlWriter $writer)
  • THtmlWriter $writer: writer for the rendering purpose

Redefinition of:
TDataGrid::render()
Renders the datagrid.
setDataSource (line 87)

Sets the data source object associated with the datagrid control.

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

  • access: public
void setDataSource (Traversable|array|string $value)
  • Traversable|array|string $value: data source object

Redefinition of:
TDataBoundControl::setDataSource()
Sets the data source object associated with the databound control.

Inherited Methods

Inherited From TDataGrid

TDataGrid::addParsedObject()
TDataGrid::applyItemStyles()
TDataGrid::bubbleEvent()
TDataGrid::buildNextPrevPager()
TDataGrid::buildNumericPager()
TDataGrid::buildPager()
TDataGrid::createAutoColumns()
TDataGrid::createItem()
TDataGrid::createPagerButton()
TDataGrid::createStyle()
TDataGrid::getAllowSorting()
TDataGrid::getAlternatingItemStyle()
TDataGrid::getAutoColumns()
TDataGrid::getAutoGenerateColumnName()
TDataGrid::getAutoGenerateColumns()
TDataGrid::getBackImageUrl()
TDataGrid::getBottomPager()
TDataGrid::getCaption()
TDataGrid::getCaptionAlign()
TDataGrid::getColumns()
TDataGrid::getEditItem()
TDataGrid::getEditItemIndex()
TDataGrid::getEditItemStyle()
TDataGrid::getEmptyTemplate()
TDataGrid::getFooter()
TDataGrid::getFooterStyle()
TDataGrid::getHeader()
TDataGrid::getHeaderStyle()
TDataGrid::getItemCount()
TDataGrid::getItems()
TDataGrid::getItemStyle()
TDataGrid::getPagerStyle()
TDataGrid::getSelectedItem()
TDataGrid::getSelectedItemIndex()
TDataGrid::getSelectedItemStyle()
TDataGrid::getShowFooter()
TDataGrid::getShowHeader()
TDataGrid::getTableBodyStyle()
TDataGrid::getTableFootStyle()
TDataGrid::getTableHeadStyle()
TDataGrid::getTagName()
TDataGrid::getTopPager()
TDataGrid::initializeItem()
TDataGrid::loadState()
TDataGrid::onCancelCommand()
TDataGrid::onDeleteCommand()
TDataGrid::onEditCommand()
TDataGrid::onItemCommand()
TDataGrid::onItemCreated()
TDataGrid::onItemDataBound()
TDataGrid::onPageIndexChanged()
TDataGrid::onPagerCreated()
TDataGrid::onSortCommand()
TDataGrid::onUpdateCommand()
TDataGrid::performDataBinding()
TDataGrid::render()
TDataGrid::renderBeginTag()
TDataGrid::renderTable()
TDataGrid::reset()
TDataGrid::restoreGridFromViewState()
TDataGrid::saveState()
TDataGrid::setAllowSorting()
TDataGrid::setAutoGenerateColumns()
TDataGrid::setBackImageUrl()
TDataGrid::setCaption()
TDataGrid::setCaptionAlign()
TDataGrid::setEditItemIndex()
TDataGrid::setEmptyTemplate()
TDataGrid::setSelectedItemIndex()
TDataGrid::setShowFooter()
TDataGrid::setShowHeader()

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

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::getDecorator()
TWebControl::getDisplay()
TWebControl::getEnsureId()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::onPreRender()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setEnsureId()
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::getIsSkinApplied()
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::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()
Class Constants

Documentation generated on Mon, 25 Jun 2012 14:36:55 +0200 by phpDocumentor 1.4.3