PHP Класс Prado\Web\UI\ActiveControls\TActiveRepeater

TActiveRepeater represents a data bound and updatable grid control which is the active counterpart to the original {@link TRepeater} control. This component can be used in the same way as the regular datagrid, the only difference is that the active repeater uses callbacks instead of postbacks for interaction. Please refer to the original documentation of the regular counterparts for usage.
С версии: 3.1.9
Автор: LANDWEHR Computer und Software GmbH ([email protected])
Наследование: extends Prado\Web\UI\WebControls\TRepeater, implements Prado\Web\UI\ActiveControls\IActiveControl, implements Prado\Web\UI\ISurroundable
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$_surroundingTag the tag used to render the surrounding container

Открытые методы

Метод Описание
__construct ( ) Creates a new callback control, sets the adapter to TActiveControlAdapter.
getActiveControl ( ) : TBaseActiveControl
getSurroundingTag ( ) : string Gets the tag used to render the surrounding container. Defaults to 'div'.
getSurroundingTagID ( ) : string Returns the id of the surrounding container.
render ( $writer ) Renders the repeater.
setDataSource ( $value ) Sets the data source object associated with the repeater control.
setSurroundingTag ( string $value ) Sets the tag used to render the surrounding container.

Приватные методы

Метод Описание
renderPager ( ) Loops through all {@link TActivePager} on the page and registers the ones which are set to paginate the repeater for rendering. This is to ensure that the connected pagers are also rendered if the data source changed.
renderRepeater ( $writer ) Renders the repeater by writing a {@link getSurroundingTag()} with the container id obtained from {@link getSurroundingTagID()} which will be called by the replacement method of the client script to update it's content.

Описание методов

__construct() публичный Метод

Creates a new callback control, sets the adapter to TActiveControlAdapter.
public __construct ( )

getActiveControl() публичный Метод

public getActiveControl ( ) : TBaseActiveControl
Результат TBaseActiveControl standard active control options.

getSurroundingTag() публичный Метод

Gets the tag used to render the surrounding container. Defaults to 'div'.
public getSurroundingTag ( ) : string
Результат string container tag

getSurroundingTagID() публичный Метод

Returns the id of the surrounding container.
public getSurroundingTagID ( ) : string
Результат string container id

render() публичный Метод

If the repeater did not pass the prerender phase yet, it will register itself for rendering later. Else it will call the {@link renderRepeater()} method which will do the rendering of the repeater.
public render ( $writer )

setDataSource() публичный Метод

In addition, the render method of all connected pagers is called so they get updated when the data source is changed. Also the repeater registers itself for rendering in order to get it's content replaced on client side.
public setDataSource ( $value )

setSurroundingTag() публичный Метод

Sets the tag used to render the surrounding container.
public setSurroundingTag ( string $value )
$value string container tag

Описание свойств

$_surroundingTag защищенное свойство

the tag used to render the surrounding container
protected $_surroundingTag