PHP Class Prado\Web\UI\WebControls\TItemDataRenderer

TItemDataRenderer is the convient base class for template-based item data renderers. It implements the {@link IItemDataRenderer} interface, and because TItemDataRenderer extends from {@link TTemplateControl}, derived child classes can have templates to define their presentational layout. The following properties are provided by TItemDataRenderer: - {@link getItemIndex ItemIndex}: zero-based index of this renderer in the item list collection. - {@link getItemType ItemType}: item type of this renderer, such as TListItemType::AlternatingItem - {@link getData Data}: data associated with this renderer

Since: 3.1.2

Author: Qiang Xue ([email protected])

Inheritance: extends TDataRenderer, implements Prado\Web\UI\WebControls\IItemDataRenderer

Mostrar archivo 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	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 )