PHP Class Prado\Web\UI\ActiveControls\TBaseActiveControl

The {@link setEnableUpdate EnableUpdate} property determines wether the active control is allowed to update the contents of the client-side when the callback response returns.
Since: 3.1
Inheritance: extends Prado\TComponent
Show file Open project: pradosoft/prado

Public Methods

Method Description
__construct ( $control ) Constructor. Attach a base active control to an active control instance.
canUpdateClientSide ( $bDontRequireVisibility = false ) : boolean Returns true if callback response is allowed to update the browser contents.
getEnableUpdate ( ) : boolean
setEnableUpdate ( $value )

Protected Methods

Method Description
getControl ( ) : TControl
getOption ( $name, $default = null ) : mixed Gets an option named value. Options are used to store and retrive named values for the base active controls.
getOptions ( ) : TMap
getPage ( ) : TPage
setOption ( $name, $value, $default = null ) : mixed Sets a named options with a value. Options are used to store and retrive named values for the base active controls.

Method Details

__construct() public method

Constructor. Attach a base active control to an active control instance.
public __construct ( $control )

canUpdateClientSide() public method

Is is true if the control is initilized, and is a callback request and the {@link setEnableUpdate EnableUpdate} property is true and the page is not loading post data.
public canUpdateClientSide ( $bDontRequireVisibility = false ) : boolean
return boolean true if the callback response is allowed update client-side contents.

getControl() protected method

protected getControl ( ) : TControl
return Prado\Web\UI\TControl the attached control.

getEnableUpdate() public method

public getEnableUpdate ( ) : boolean
return boolean true to allow fine grain callback updates.

getOption() protected method

Gets an option named value. Options are used to store and retrive named values for the base active controls.
protected getOption ( $name, $default = null ) : mixed
return mixed options value.

getOptions() protected method

protected getOptions ( ) : TMap
return Prado\Collections\TMap active control options

getPage() protected method

protected getPage ( ) : TPage
return TPage the page containing the attached control.

setEnableUpdate() public method

public setEnableUpdate ( $value )

setOption() protected method

Sets a named options with a value. Options are used to store and retrive named values for the base active controls.
protected setOption ( $name, $value, $default = null ) : mixed
return mixed options value.