PHP Class Prado\Web\UI\ActiveControls\TActiveMultiView

TActiveMultiView is the active counterpart to the original {@link TMultiView} control. It re-renders on Callback when {@link setActiveView ActiveView} or {@link setActiveViewIndex ActiveViewIndex} is called. Please refer to the original documentation of the regular counterpart for usage.
Since: 3.1.6
Author: LANDWEHR Computer und Software GmbH ([email protected])
Inheritance: extends Prado\Web\UI\WebControls\TMultiView, implements Prado\Web\UI\ActiveControls\IActiveControl
Datei anzeigen Open project: pradosoft/prado

Public Methods

Method Description
__construct ( ) Creates a new callback control, sets the adapter to TActiveControlAdapter.
getActiveControl ( ) : TBaseActiveControl
render ( $writer ) Renders the TActiveMultiView.
setActiveView ( $value )
setActiveViewIndex ( $value )

Protected Methods

Method Description
getContainerID ( ) : string Returns the id of the surrounding container (span).
renderMultiView ( $writer ) Renders the TActiveMultiView by writing a span tag with the container id obtained from {@link getContainerID()} which will be called by the replacement method of the client script to update it's content.

Method Details

__construct() public method

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

getActiveControl() public method

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

getContainerID() protected method

Returns the id of the surrounding container (span).
protected getContainerID ( ) : string
return string container id

render() public method

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

renderMultiView() protected method

Renders the TActiveMultiView by writing a span tag with the container id obtained from {@link getContainerID()} which will be called by the replacement method of the client script to update it's content.
protected renderMultiView ( $writer )
$writer THtmlWriter writer for the rendering purpose

setActiveView() public method

public setActiveView ( $value )

setActiveViewIndex() public method

public setActiveViewIndex ( $value )