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

TActiveDataGrid represents a data bound and updatable grid control which is the active counterpart to the original {@link TDataGrid} control. This component can be used in the same way as the regular datagrid, the only difference is that the active datagrid uses callbacks instead of postbacks for interaction. There are also active datagrid columns to work with the TActiveDataGrid, which are - {@link TActiveBoundColumn}, the active counterpart to {@link TBoundColumn}. - {@link TActiveLiteralColumn}, the active counterpart to {@link TLiteralColumn}. - {@link TActiveCheckBoxColumn}, the active counterpart to {@link TCheckBoxColumn}. - {@link TActiveDropDownListColumn}, the active counterpart to {@link TDropDownListColumn}. - {@link TActiveHyperLinkColumn}, the active counterpart to {@link THyperLinkColumn}. - {@link TActiveEditCommandColumn}, the active counterpart to {@link TEditCommandColumn}. - {@link TActiveButtonColumn}, the active counterpart to {@link TButtonColumn}. - {@link TActiveTemplateColumn}, the active counterpart to {@link TTemplateColumn}. 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\TDataGrid, 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 datagrid.
setDataSource ( $value ) Sets the data source object associated with the datagrid control.
setSurroundingTag ( string $value ) Sets the tag used to render the surrounding container.

Защищенные методы

Метод Описание
createPager ( )
createPagerButton ( $pager, $buttonType, $enabled, $text, $commandName, $commandParameter ) : mixed Creates a pager button.
getAutoGenerateColumnName ( ) : string

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

Метод Описание
renderDataGrid ( $writer ) Renders the datagrid 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.
renderPager ( ) Loops through all {@link TActivePager} on the page and registers the ones which are set to paginate the datagrid for rendering. This is to ensure that the connected pagers are also rendered if the data source changed.

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

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

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

createPager() защищенный Метод

protected createPager ( )

createPagerButton() защищенный Метод

Depending on the button type, a TActiveLinkButton or a TActiveButton may be created. If it is enabled (clickable), its command name and parameter will also be set. It overrides the datagrid's original method to create active controls instead, thus the pager will do callbacks instead of the regular postbacks.
protected createPagerButton ( $pager, $buttonType, $enabled, $text, $commandName, $commandParameter ) : mixed
Результат mixed the button instance

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

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

getAutoGenerateColumnName() защищенный Метод

protected getAutoGenerateColumnName ( ) : string
Результат string Name of the class used in AutoGenerateColumns mode

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 datagrid did not pass the prerender phase yet, it will register itself for rendering later. Else it will call the {@link renderDataGrid()} method which will do the rendering of the datagrid.
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 datagrid 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