Class TActivePageAdapter
TActivePageAdapter class.
Callback request handler.
| Constructor Summary |
| public |
Constructor, trap errors and exception to let the callback response handle them.
|
| Method Summary |
|
TCallbackClientScript
|
Gets the callback client script handler. It handlers the javascript functions to be executed during the callback response.
|
|
string
|
Gets callback parameter. JSON encoding is assumed.
|
|
TControl
|
|
|
void
|
Process the callback request.
|
|
protected
void
|
Redirect url on the client-side using javascript.
|
|
void
|
Register a control for defered render() call.
|
|
void
|
Render the callback response.
|
|
protected
void
|
Renders the callback response by adding additional callback data and javascript actions in the header and page state if required.
|
|
void
|
|
|
void
|
Registers a control to raise callback event in the current request.
|
|
protected
void
|
Trap errors and exceptions to be handled by TCallbackErrorHandler.
|
| Methods Inherited From TControlAdapter |
|
TControlAdapter::createChildControls(), TControlAdapter::getControl(), TControlAdapter::getPage(), TControlAdapter::loadState(), TControlAdapter::onInit(), TControlAdapter::onLoad(), TControlAdapter::onPreRender(), TControlAdapter::onUnload(), TControlAdapter::render(), TControlAdapter::renderChildren(), TControlAdapter::saveState()
|
| Methods Inherited From TComponent |
|
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
| Constructor Details |
__construct
Constructor, trap errors and exception to let the callback response handle them.
|
| Method Details |
getCallbackClientHandler
Gets the callback client script handler. It handlers the javascript functions to be executed during the callback response.
|
getCallbackEventParameter
| public string getCallbackEventParameter |
() |
Gets callback parameter. JSON encoding is assumed.
| Output |
|
string
| postback event parameter |
| Exception |
|
getCallbackEventTarget
| public TControl getCallbackEventTarget |
() |
| Output |
|
TControl
| the control responsible for the current callback event, null if nonexistent |
| Exception |
|
processCallbackEvent
| public void processCallbackEvent |
(THtmlWriter $writer ) |
Process the callback request.
| Input |
| THtmlWriter | $writer | html content writer. |
| Output |
| Exception |
|
redirect
| protected void redirect |
(string $url ) |
Redirect url on the client-side using javascript.
| Input |
| string | $url | new url to load. |
| Output |
| Exception |
|
registerControlToRender
Register a control for defered render() call.
| Input |
| TControl | $control | control for defered rendering |
| THtmlWriter | $writer | the renderer |
| Output |
| Exception |
|
renderCallbackResponse
| public void renderCallbackResponse |
(THtmlWriter $writer ) |
Render the callback response.
| Input |
| THtmlWriter | $writer | html content writer. |
| Output |
| Exception |
|
renderResponse
Renders the callback response by adding additional callback data and javascript actions in the header and page state if required.
| Input |
| THtmlWriter | $writer | html content writer. |
| Output |
| Exception |
|
setCallbackEventParameter
| public void setCallbackEventParameter |
(mixed $value ) |
| Input |
| mixed | $value | postback event parameter |
| Output |
| Exception |
|
setCallbackEventTarget
| public void setCallbackEventTarget |
(TControl $control ) |
Registers a control to raise callback event in the current request.
| Input |
| TControl | $control | control registered to raise callback event. |
| Output |
| Exception |
|
trapCallbackErrorsExceptions
| protected void trapCallbackErrorsExceptions |
() |
Trap errors and exceptions to be handled by TCallbackErrorHandler.
|
| Constant Details |
CALLBACK_ACTION_HEADER
Callback response client-side action header name.
Type:
string
Value:
'X-PRADO-ACTIONS'
|
CALLBACK_DATA_HEADER
Callback response data header name.
Type:
string
Value:
'X-PRADO-DATA'
|
CALLBACK_ERROR_HEADER
Callback error header name.
Type:
string
Value:
'X-PRADO-ERROR'
|
CALLBACK_PAGESTATE_HEADER
Callback page state header name.
Type:
string
Value:
'X-PRADO-PAGESTATE'
|
CALLBACK_REDIRECT
Callback redirect url header name.
Type:
string
Value:
'X-PRADO-REDIRECT'
|
|