PHP Class Prado\Web\UI\ActiveControls\TActivePager

When a page change is requested, TActivePager raises a callback instead of the traditional postback. The {@link onCallback OnCallback} event is raised during a callback request and it is raise after the {@link onPageIndexChanged OnPageIndexChanged} event.
Since: 3.1.2
Author: "gevik" (forum contributor) and Christophe Boulain ([email protected])
Inheritance: extends Prado\Web\UI\WebControls\TPager, implements Prado\Web\UI\ActiveControls\IActiveControl, implements Prado\Web\UI\ActiveControls\ICallbackEventHandler
Datei anzeigen Open project: pradosoft/prado

Public Methods

Method Description
__construct ( ) Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
getActiveControl ( ) : TBaseActiveControl
getClientSide ( ) : TCallbackClientSide
handleCallback ( mixed $sender, TCallbackEventParameter $param ) Event handler to the OnCallback active buttons or active dropdownlist.
onCallback ( $param ) This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.
raiseCallbackEvent ( $param ) Raises the callback event. This method is required by {@link ICallbackEventHandler} interface.
render ( $writer )

Protected Methods

Method Description
buildListPager ( ) Builds a dropdown list pager Override parent implementation to build Active dropdown lists.
createPagerButton ( $buttonType, $enabled, $text, $commandName, $commandParameter ) : mixed Creates a pager button.

Method Details

__construct() public method

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
public __construct ( )

buildListPager() protected method

Builds a dropdown list pager Override parent implementation to build Active dropdown lists.
protected buildListPager ( )

createPagerButton() protected method

Override parent implementation to create, depending on the button type, a TActiveLinkButton, a TActiveButton or a TActiveImageButton may be created.
protected createPagerButton ( $buttonType, $enabled, $text, $commandName, $commandParameter ) : mixed
return mixed the button instance

getActiveControl() public method

public getActiveControl ( ) : TBaseActiveControl
return TBaseActiveControl standard active control options.

getClientSide() public method

public getClientSide ( ) : TCallbackClientSide
return TCallbackClientSide client side request options.

handleCallback() public method

This handler will raise the {@link onCallback OnCallback} event
public handleCallback ( mixed $sender, TCallbackEventParameter $param )
$sender mixed
$param TCallbackEventParameter

onCallback() public method

This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.
public onCallback ( $param )

raiseCallbackEvent() public method

This method is mainly used by framework and control developers.
public raiseCallbackEvent ( $param )

render() public method

public render ( $writer )