PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TActiveDataGrid

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

  • TActiveBoundColumn, the active counterpart to TBoundColumn.
  • TActiveLiteralColumn, the active counterpart to TLiteralColumn.
  • TActiveCheckBoxColumn, the active counterpart to TCheckBoxColumn.
  • TActiveDropDownListColumn, the active counterpart to TDropDownListColumn.
  • TActiveHyperLinkColumn, the active counterpart to THyperLinkColumn.
  • TActiveEditCommandColumn, the active counterpart to TEditCommandColumn.
  • TActiveButtonColumn, the active counterpart to TButtonColumn.
  • TActiveTemplateColumn, the active counterpart to TTemplateColumn.

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

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TDataBoundControl
Extended by TBaseDataList
Extended by TDataGrid implements INamingContainer
Extended by TActiveDataGrid implements IActiveControl, ISurroundable
Package: System\Web\UI\ActiveControls
Copyright: Copyright © 2009 LANDWEHR Computer und Software GmbH
License: http://www.pradosoft.com/license/
Author: LANDWEHR Computer und Software GmbH <programmierung@landwehr-software.de>
Since: 3.1.9
Located at Web/UI/ActiveControls/TActiveDataGrid.php
Methods summary
protected string
# getAutoGenerateColumnName( )

Returns

string
Name of the class used in AutoGenerateColumns mode

Overrides

TDataGrid::getAutoGenerateColumnName()
public
# __construct( )

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

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

Overrides

TControl::__construct()
public TBaseActiveControl
# getActiveControl( )

Returns

TBaseActiveControl
standard active control options.

Implementation of

IActiveControl::getActiveControl()
public
# setDataSource( Traversable|array|string $value )

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.

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.

Parameters

$value
Traversable|array|string
data source object

Overrides

TDataBoundControl::setDataSource()
public string
# getSurroundingTagId( )

Returns the id of the surrounding container (div).

Returns the id of the surrounding container (div).

Returns

string
container id
protected mixed
# createPagerButton( mixed $pager, string $buttonType, boolean $enabled, string $text, string $commandName, string $commandParameter )

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.

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.

Parameters

$pager
mixed
the container pager instance of TActiveDatagridPager
$buttonType
string
button type, either LinkButton or PushButton
$enabled
boolean
whether the button should be enabled
$text
string
caption of the button
$commandName
string
CommandName corresponding to the OnCommand event of the button
$commandParameter
string
CommandParameter corresponding to the OnCommand event of the button

Returns

mixed
the button instance

Overrides

TDataGrid::createPagerButton()
protected
# createPager( )

Overrides

TDataGrid::createPager()
public
# render( THtmlWriter $writer )

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.

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.

Parameters

$writer
THtmlWriter
writer for the rendering purpose

Overrides

TDataGrid::render()
Methods inherited from TDataGrid
addParsedObject(), applyItemStyles(), bubbleEvent(), buildNextPrevPager(), buildNumericPager(), buildPager(), createAutoColumns(), createItem(), createStyle(), getAllowSorting(), getAlternatingItemStyle(), getAutoColumns(), getAutoGenerateColumns(), getBackImageUrl(), getBottomPager(), getCaption(), getCaptionAlign(), getColumns(), getEditItem(), getEditItemIndex(), getEditItemStyle(), getEmptyTemplate(), getFooter(), getFooterStyle(), getHeader(), getHeaderStyle(), getItemCount(), getItemStyle(), getItems(), getPagerStyle(), getSelectedItem(), getSelectedItemIndex(), getSelectedItemStyle(), getShowFooter(), getShowHeader(), getTableBodyStyle(), getTableFootStyle(), getTableHeadStyle(), getTagName(), getTopPager(), initializeItem(), loadState(), onCancelCommand(), onDeleteCommand(), onEditCommand(), onItemCommand(), onItemCreated(), onItemDataBound(), onPageIndexChanged(), onPagerCreated(), onSortCommand(), onUpdateCommand(), performDataBinding(), renderBeginTag(), renderTable(), reset(), restoreGridFromViewState(), saveState(), setAllowSorting(), setAutoGenerateColumns(), setBackImageUrl(), setCaption(), setCaptionAlign(), setEditItemIndex(), setEmptyTemplate(), setSelectedItemIndex(), setShowFooter(), setShowHeader()
Methods inherited from TBaseDataList
getCellPadding(), getCellSpacing(), getDataFieldValue(), getDataKeyField(), getDataKeys(), getGridLines(), getHorizontalAlign(), onSelectedIndexChanged(), setCellPadding(), setCellSpacing(), setDataKeyField(), setGridLines(), setHorizontalAlign()
Methods inherited from TDataBoundControl
createPagedDataSource(), dataBind(), dataSourceViewChanged(), determineDataSource(), ensureDataBound(), getAllowCustomPaging(), getAllowPaging(), getCurrentPageIndex(), getDataMember(), getDataSource(), getDataSourceID(), getDataSourceView(), getInitialized(), getIsDataBound(), getPageCount(), getPageSize(), getRequiresDataBinding(), getSelectParameters(), getUsingDataSourceID(), getVirtualItemCount(), onDataBound(), onDataSourceChanged(), onInit(), onPreRender(), pagePreLoad(), setAllowCustomPaging(), setAllowPaging(), setCurrentPageIndex(), setDataMember(), setDataSourceID(), setInitialized(), setIsDataBound(), setPageSize(), setRequiresDataBinding(), setVirtualItemCount(), validateDataSource()
Methods inherited from TWebControl
addAttributesToRender(), clearStyle(), copyBaseAttributes(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), renderContents(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setDisplay(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__get(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadStateRecursive(), onDataBinding(), onLoad(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setEnabled(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Methods inherited from ISurroundable
getSurroundingTagID()
Constants inherited from TDataGrid
CMD_CANCEL, CMD_DELETE, CMD_EDIT, CMD_PAGE, CMD_PAGE_FIRST, CMD_PAGE_LAST, CMD_PAGE_NEXT, CMD_PAGE_PREV, CMD_SELECT, CMD_SORT, CMD_UPDATE, IT_ALTERNATINGITEM, IT_EDITITEM, IT_FOOTER, IT_HEADER, IT_ITEM, IT_PAGER, IT_SELECTEDITEM, IT_SEPARATOR
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
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TWebControl
$_decorator
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO