PHP Class Prado\Web\UI\WebControls\TDataGridItem

A TDataGridItem control represents an item in the {@link TDataGrid} control, such as heading section, footer section, or a data item. The index and data value of the item can be accessed via {@link getItemIndex ItemIndex}> and {@link getDataItem DataItem} properties, respectively. The type of the item is given by {@link getItemType ItemType} property. Property {@link getDataSourceIndex DataSourceIndex} gives the index of the item from the bound data source.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends TTableRow, implements Prado\Web\UI\INamingContainer
显示文件 Open project: pradosoft/prado

Public Methods

Method Description
__construct ( $itemIndex, $dataSourceIndex, $itemType ) Constructor.
bubbleEvent ( $sender, $param ) : boolean This method overrides parent's implementation by wrapping event parameter for OnCommand event with item information.
getData ( ) : mixed
getDataItem ( ) : mixed This property is deprecated since v3.1.0.
getDataSourceIndex ( ) : integer
getItemIndex ( ) : integer
getItemType ( ) : TListItemType
setData ( $value )
setDataItem ( $value ) This property is deprecated since v3.1.0.
setItemType ( $value )

Method Details

__construct() public method

Constructor.
public __construct ( $itemIndex, $dataSourceIndex, $itemType )

bubbleEvent() public method

This method overrides parent's implementation by wrapping event parameter for OnCommand event with item information.
public bubbleEvent ( $sender, $param ) : boolean
return boolean whether the event bubbling should stop here.

getData() public method

Since: 3.1.0
public getData ( ) : mixed
return mixed data associated with the item

getDataItem() public method

This property is deprecated since v3.1.0.
Deprecation: deprecated since v3.1.0. Use {@link getData} instead.
public getDataItem ( ) : mixed
return mixed data associated with the item

getDataSourceIndex() public method

public getDataSourceIndex ( ) : integer
return integer the index of the datagrid item from the bound data source

getItemIndex() public method

public getItemIndex ( ) : integer
return integer zero-based index of the item in the item collection of datagrid

getItemType() public method

public getItemType ( ) : TListItemType
return TListItemType item type.

setData() public method

Since: 3.1.0
public setData ( $value )

setDataItem() public method

This property is deprecated since v3.1.0.
Deprecation: deprecated since version 3.1.0. Use {@link setData} instead.
public setDataItem ( $value )

setItemType() public method

public setItemType ( $value )