PHP Interface Prado\Web\UI\WebControls\IItemDataRenderer

IItemDataRenderer defines the interface that an item renderer needs to implement. Besides the {@link getData Data} property, a list item renderer also needs to provide {@link getItemIndex ItemIndex} and {@link getItemType ItemType} property.

Since: 3.1.0

Author: Qiang Xue ([email protected])

Inheritance: extends Prado\IDataRenderer

Exibir arquivo Open project: pradosoft/prado

Public Methods

Method	Description
getItemIndex ( ) : integer	Returns a value indicating the zero-based index of the item in the corresponding data control's item collection.
getItemType ( ) : TListItemType
setItemIndex ( $value )	Sets the zero-based index for the item.
setItemType ( $value )

Method Details

getItemIndex() public method

If the item is not in the collection (e.g. it is a header item), it returns -1.

public getItemIndex ( ) : integer
return	integer	zero-based index of the item.

getItemType() public method

public getItemType ( ) : TListItemType
return	TListItemType	the item type.

setItemIndex() public method

If the item is not in the item collection (e.g. it is a header item), -1 should be used.

public setItemIndex ( $value )

setItemType() public method

public setItemType ( $value )