Class \Prado\Web\UI\WebControls\TTemplateColumn

TTemplateColumn class

TTemplateColumn customizes the layout of controls in the column with templates. In particular, you can specify \Prado\Web\UI\WebControls\setItemTemplate, \Prado\Web\UI\WebControls\setEditItemTemplate, \Prado\Web\UI\WebControls\setHeaderTemplate and \Prado\Web\UI\WebControls\setFooterTemplate to customize specific type of cells in the column.

Since v3.1.0, TTemplateColumn has introduced two new properties \Prado\Web\UI\WebControls\setItemRenderer and \Prado\Web\UI\WebControls\setEditItemRenderer which can be used to specify the layout of the datagrid cells in browsing and editing mode. A renderer refers to a control class that is to be instantiated as a control. For more details, see TRepeater and TDataList.

When a renderer and a template are both defined for a type of item, the former takes precedence.

Class hierarchy

\Prado\Web\UI\WebControls\TTemplateColumn

\Prado\Web\UI\WebControls\TDataGridColumn

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`dataBindColumn(mixed $sender, mixed $param) : mixed` Databinds a cell in the column. This method is invoked when datagrid performs databinding. It populates the content of the cell with the relevant data from data source.
`public`	`getEditItemRenderer() : string`
`public`	`getEditItemTemplate() : ITemplate`
`public`	`getFooterTemplate() : ITemplate`
`public`	`getHeaderTemplate() : ITemplate`
`public`	`getItemRenderer() : string`
`public`	`getItemTemplate() : ITemplate`
`public`	`initializeCell(TTableCell $cell, int $columnIndex, string $itemType) : mixed` Initializes the specified cell to its initial values. This method overrides the parent implementation. It initializes the cell based on different templates (ItemTemplate, EditItemTemplate, HeaderTemplate, FooterTemplate).
`public`	`setEditItemRenderer(string $value) : mixed` Sets the edit item cell renderer class. If not empty, the class will be used to instantiate as a child control in the item cell that is in edit mode. If the class implements IDataRenderer, the Data property will be set as the row of the data associated with the datagrid item that this cell resides in.
`public`	`setEditItemTemplate(ITemplate $value) : mixed`
`public`	`setFooterTemplate(ITemplate $value) : mixed`
`public`	`setHeaderTemplate(ITemplate $value) : mixed`
`public`	`setItemRenderer(string $value) : mixed` Sets the item cell renderer class. If not empty, the class will be used to instantiate as a child control in the item cells of the column. If the class implements IDataRenderer, the Data property will be set as the row of the data associated with the datagrid item that this cell resides in.
`public`	`setItemTemplate(ITemplate $value) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAllowSorting, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEnableCellGrouping, getEventHandlers, getFooterRenderer, getFooterStyle, getFooterText, getHeaderImageUrl, getHeaderRenderer, getHeaderStyle, getHeaderText, getID, getItemStyle, getListeningToGlobalEvents, getOwner, getRequest, getResponse, getService, getSession, getSortExpression, getSubProperty, getUser, getVisible, hasEvent, hasEventHandler, hasMethod, hasProperty, initialize, initializeCell, isa, listen, loadState, publishAsset, publishFilePath, raiseEvent, saveState, setEnableCellGrouping, setFooterRenderer, setFooterText, setHeaderImageUrl, setHeaderRenderer, setHeaderText, setID, setOwner, setSortExpression, setSubProperty, setVisible, unlisten, _getZappableSleepProps, formatDataValue, getCallChain, getClassFxEvents, getDataFieldValue, getViewState, initializeCellRendererControl, initializeFooterCell, initializeHeaderCell, instanceBehavior, setViewState, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TTemplateColumn

Class hierarchy