PHP Class Prado\Web\UI\ActiveControls\TActiveTableRow

TActiveTableRow is the active counterpart to the original {@link TTableRow} control and displays a table row. The table cells in the row can be accessed via {@link getCells Cells}. The horizontal and vertical alignments of the row are specified via {@link setHorizontalAlign HorizontalAlign} and {@link setVerticalAlign VerticalAlign} properties, respectively. TActiveTableRow allows the contents of the table row to be changed during callback. When {@link onRowSelected RowSelected} property is set, selecting (clicking on) the row will perform a callback request causing {@link onRowSelected OnRowSelected} event to be fired. It will also respond to a bubbled {@link onCellSelected OnCellSelected} event of a {@link TActiveTableCell} child control and fire a {@link onRowSelected OnRowSelected} event. TActiveTableRow allows the client-side row contents to be updated during a callback response by getting a new writer, invoking the render method and flushing the output, similar to a {@link TActivePanel} control.


function callback_request($sender, $param)
{
    $this->active_row->render($param->getNewWriter());
}

Please refer to the original documentation of the regular counterpart for usage.

Since: 3.1.9

Author: LANDWEHR Computer und Software GmbH ([email protected])

Inheritance: extends Prado\Web\UI\WebControls\TTableRow, implements Prado\Web\UI\ActiveControls\ICallbackEventHandler, implements Prado\Web\UI\ActiveControls\IActiveControl

Mostra file Open project: pradosoft/prado

Public Methods

Method	Description
__construct ( )	Creates a new callback control, sets the adapter to TActiveControlAdapter.
bubbleEvent ( $sender, $param ) : boolean	This method overrides parent's implementation and raises the control's callback event. This will fire the {@link onRowSelected OnRowSelected} event if an appropriate event handler is implemented.
getActiveControl ( ) : TBaseActiveCallbackControl
getClientSide ( ) : TCallbackClientSide
getRowIndex ( ) : integer	Returns the zero-based index of the TActiveTableRow within the {@link TTableRowCollection} of the parent {@link TTable} control. Raises a {@link TConfigurationException} if the row is no member of the row collection.
getTable ( ) : TTable	Returns the parent {@link TTable} control by looping through all parents until a {@link TTable} is found. Raises a {@link TConfigurationException} if no table control is found.
onRowSelected ( $param )	This method is invoked when a callback is requested. The method raises 'OnRowSelected' 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. It will raise {@link onRowSelected OnRowSelected} event with a {@link TActiveTableRowEventParameter} containing the zero-based index of the TActiveTableRow.
render ( $writer )	Renders and replaces the row's content on the client-side. When render() is called before the OnPreRender event, such as when render() is called during a callback event handler, the rendering is defered until OnPreRender event is raised.

Protected Methods

Method	Description
addAttributesToRender ( $writer )	Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control if the event handler for the {@link onRowSelected OnRowSelected} event is set.
getClientClassName ( ) : string
getPostBackOptions ( ) : array	Returns postback specifications for the table row.

Method Details

__construct() public method

Creates a new callback control, sets the adapter to TActiveControlAdapter.

public __construct ( )

addAttributesToRender() protected method

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control if the event handler for the {@link onRowSelected OnRowSelected} event is set.

protected addAttributesToRender ( $writer )

bubbleEvent() public method

This method overrides parent's implementation and raises the control's callback event. This will fire the {@link onRowSelected OnRowSelected} event if an appropriate event handler is implemented.

public bubbleEvent ( $sender, $param ) : boolean
return	boolean	whether the event bubbling should stop here.

getActiveControl() public method

public getActiveControl ( ) : TBaseActiveCallbackControl
return	TBaseActiveCallbackControl	standard callback control options.

getClientClassName() protected method

protected getClientClassName ( ) : string
return	string	corresponding javascript class name for this TActiveTableRow.

getClientSide() public method

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

getPostBackOptions() protected method

This method is used by framework and control developers.

protected getPostBackOptions ( ) : array
return	array	parameters about how the row defines its postback behavior.

getRowIndex() public method

Returns the zero-based index of the TActiveTableRow within the {@link TTableRowCollection} of the parent {@link TTable} control. Raises a {@link TConfigurationException} if the row is no member of the row collection.

public getRowIndex ( ) : integer
return	integer	the zero-based index of the row

getTable() public method

Returns the parent {@link TTable} control by looping through all parents until a {@link TTable} is found. Raises a {@link TConfigurationException} if no table control is found.

public getTable ( ) : TTable
return	Prado\Web\UI\WebControls\TTable	the parent table control

onRowSelected() public method

This method is invoked when a callback is requested. The method raises 'OnRowSelected' 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 onRowSelected ( $param )

raiseCallbackEvent() public method

This method is mainly used by framework and control developers.

public raiseCallbackEvent ( $param )

render() public method

Renders and replaces the row's content on the client-side. When render() is called before the OnPreRender event, such as when render() is called during a callback event handler, the rendering is defered until OnPreRender event is raised.

public render ( $writer )