Class TRepeater
TRepeater class.
TRepeater displays its content repeatedly based on the data fetched from
setDataSource DataSource. The repeated contents in TRepeater are called
items, which are controls and can be accessed through getItems Items.
When TDataBoundControl::dataBind()
is invoked, TRepeater creates an item for each row of
data and binds the data row to the item. Optionally, a repeater can have a
header, a footer and/or separators between items.
The layout of the repeated contents are specified by inline templates. Repeater items, header, footer, etc. are being instantiated with the corresponding templates when data is being bound to the repeater.
Since v3.1.0, the layout can also be specified by renderers. A renderer is a control class that can be instantiated as repeater items, header, etc. A renderer can thus be viewed as an external template (in fact, it can also be non-templated controls).
A renderer can be any control class.
- If the class implements
IDataRenderer
, the Data
property will be set as the data row during databinding. Many PRADO controls
implement this interface, such as TLabel
, TTextBox
, etc.
- If the class implements
IItemDataRenderer
, the ItemIndex property will be set
as the zero-based index of the item in the repeater item collection, and the
ItemType property as the item's type (such as TListItemType::Item).
TRepeaterItemRenderer
may be used as the convenient base class which
already implements IDataItemRenderer.
The following properties are used to specify different types of template and renderer for a repeater:
- setItemTemplate ItemTemplate, setItemRenderer ItemRenderer:
for each repeated row of data
- setAlternatingItemTemplate AlternatingItemTemplate, setAlternatingItemRenderer AlternatingItemRenderer:
for each alternating row of data. If not set, setItemTemplate ItemTemplate or setItemRenderer ItemRenderer will be used instead.
- setHeaderTemplate HeaderTemplate, setHeaderRenderer HeaderRenderer:
for the repeater header.
- setFooterTemplate FooterTemplate, setFooterRenderer FooterRenderer:
for the repeater footer.
- setSeparatorTemplate SeparatorTemplate, setSeparatorRenderer SeparatorRenderer:
for content to be displayed between items.
- setEmptyTemplate EmptyTemplate, setEmptyRenderer EmptyRenderer:
used when data bound to the repeater is empty.
If a content type is defined with both a template and a renderer, the latter takes precedence.
When TDataBoundControl::dataBind()
is being called, TRepeater undergoes the following
lifecycles for each row of data:
- create item based on templates or renderers
- set the row of data to the item
- raise onItemCreated OnItemCreated:
- add the item as a child control
- call dataBind() of the item
- raise onItemDataBound OnItemDataBound:
TRepeater raises an onItemCommand OnItemCommand whenever a button control within some repeater item raises a OnCommand event. Therefore, you can handle all sorts of OnCommand event in a central place by writing an event handler for onItemCommand OnItemCommand.
When a page containing a repeater is post back, the repeater will restore automatically all its contents, including items, header, footer and separators. However, the data row associated with each item will not be recovered and become null. To access the data, use one of the following ways:
- Use getDataKeys DataKeys to obtain the data key associated with
the specified repeater item and use the key to fetch the corresponding data from some persistent storage such as DB.
- Save the whole dataset in viewstate, which will restore the dataset automatically upon postback.
Be aware though, if the size of your dataset is big, your page size will become big. Some complex data may also have serializing problem if saved in viewstate.
- TComponent
-
TApplicationComponent
-
TControl implements IRenderable, IBindable
-
TWebControl implements IStyleable
-
TDataBoundControl
-
TRepeater implements INamingContainer
Direct known subclasses
TActiveRepeaterCopyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/TRepeater.php
public
string
|
|
public
|
|
public
string
|
|
public
|
|
public
string
|
|
public
|
|
public
string
|
|
public
|
|
public
string
|
|
public
|
|
public
string
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
string
|
|
public
|
|
public
|
|
protected
|
#
createItem( integer $itemIndex,
Creates a repeater item instance based on the item type and index. |
protected
|
|
public
|
#
render(
Renders the repeater. This method overrides the parent implementation by rendering the body content as the whole presentation of the repeater. Outer tag is not rendered. |
public
|
#
saveState( )
Saves item count in viewstate. This method is invoked right before control state is to be saved. |
public
|
#
loadState( )
Loads item count information from viewstate. This method is invoked right after control state is loaded. |
public
|
|
protected
|
|
protected
|
#
performDataBinding( Traversable $data )
Performs databinding to populate repeater items from data source. This method is invoked by dataBind(). You may override this function to provide your own way of data population. |
public
boolean
|
#
bubbleEvent(
This method overrides parent's implementation to handle onItemCommand OnItemCommand event which is bubbled from repeater items and their child controls. This method should only be used by control developers. |
public
|
#
onItemCreated(
Raises OnItemCreated event. This method is invoked after a repeater item is created and instantiated with template, but before added to the page hierarchy. The repeater item control responsible for the event can be determined from the event parameter. If you override this method, be sure to call parent's implementation so that event handlers have chance to respond to the event. |
public
|
#
onItemDataBound(
Raises OnItemDataBound event. This method is invoked right after an item is data bound. The repeater item control responsible for the event can be determined from the event parameter. If you override this method, be sure to call parent's implementation so that event handlers have chance to respond to the event. |
public
|
#
onItemCommand(
Raises OnItemCommand event. This method is invoked after a button control in a template raises OnCommand event. The repeater control responsible for the event can be determined from the event parameter. The event parameter also contains the information about the initial sender of the OnCommand event, command name and command parameter. You may override this method to provide customized event handling. Be sure to call parent's implementation so that event handlers have chance to respond to the event. |
protected
mixed
|
#
getDataFieldValue( mixed $data, mixed $field )
Returns the value of the data at the specified field. If data is an array, TMap or TList, the value will be returned at the index of the specified field. If the data is a component with a property named as the field name, the property value will be returned. Otherwise, an exception will be raised. |
getApplication(),
getRequest(),
getResponse(),
getService(),
getSession(),
getUser(),
publishAsset(),
publishFilePath()
|
string |
IT_HEADER |
'Header' |
#
Repeater item types |
string |
IT_FOOTER |
'Footer' |
|
string |
IT_ITEM |
'Item' |
|
string |
IT_SEPARATOR |
'Separator' |
|
string |
IT_ALTERNATINGITEM |
'AlternatingItem' |
GLOBAL_RAISE_EVENT_LISTENER
|
$_decorator
|