Class \Prado\Web\UI\ActiveControls\TBaseActiveCallbackControl

TBaseActiveCallbackControl is a common set of options and functionality for active controls that can perform callback requests.

The properties of TBaseActiveCallbackControl can be accessed and changed from each individual active controls' \Prado\Web\UI\ActiveControls\getActiveControl property.

The following example sets the validation group property of a TCallback component.

	<com:TCallback ActiveControl.ValidationGroup="group1" ... />

Additional client-side options and events can be set using the \Prado\Web\UI\ActiveControls\getClientSide property. The following example shows an alert box when a TCallback component response returns successfully.

	<com:TCallback ActiveControl.ClientSide.OnSuccess="alert('ok!')" ... />

Class hierarchy

\Prado\Web\UI\ActiveControls\TBaseActiveCallbackControl

\Prado\Web\UI\ActiveControls\TBaseActiveControl

\Prado\TComponent

Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.1

Methods summary
`public`	`canCauseValidation() : bool`
`public`	`getCallbackOptions() : string`
`public`	`getCallbackParameter() : mixed`
`public`	`getCausesValidation() : bool`
`public`	`getClientSide() : TCallbackClientSide` Callback client-side options can be set by setting the properties of the ClientSide property. E.g. <com:TCallback ActiveControl.ClientSide.OnSuccess="..." /> See {@see \Prado\Web\UI\ActiveControls\TCallbackClientSide} for details on the properties of ClientSide.
`public`	`getJavascript() : string` Returns the javascript callback request instance. To invoke a callback request for this control call the <tt>dispatch()</tt> method on the request instance. Example code in javascript ```js var request = <%= $this->mycallback->ActiveControl->Javascript %>; request.setParameter('hello'); request.dispatch(); //make the callback request. Alternatively, ```js //dispatches immediately Prado.Callback("<%= $this->mycallback->UniqueID %>", $this->mycallback->ActiveControl->JsCallbackOptions);
`public`	`getJsCallbackOptions() : string`
`public`	`getValidationGroup() : string`
`public`	`registerCallbackClientScript(string $class[, null\|array<string\|int, mixed> $options = null ]) : mixed` Registers the callback control javascript code. Client-side options are merged and passed to the javascript code. This method should be called by Active component developers wanting to register the javascript to initialize the active component with additional options offered by the {@see getClientSide ClientSide} property.
`public`	`setCallbackOptions(string $value) : mixed` Sets default callback options. Takes the ID of a TCallbackOptions component to duplicate the client-side options for this control. The {@see getClientSide ClientSide} subproperties takes precedence over the CallbackOptions property.
`public`	`setCallbackParameter(mixed $value) : mixed`
`public`	`setCausesValidation(bool $value) : mixed`
`public`	`setClientSide(TCallbackClientSide $client) : mixed` Sets the client side options. Can only be set when client side is null.
`public`	`setValidationGroup(string $value) : mixed`
`protected`	`createClientSide() : TCallbackClientSide`
`protected`	`getClientSideOptions() : array<string\|int, mixed>`
`protected`	`getDefaultClientSideOptions() : array<string\|int, mixed>` Returns an array of default callback client-side options. The default options are obtained from the client-side options of a TCallbackOptions control with ID specified by {@see setCallbackOptions CallbackOptions}.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, canUpdateClientSide, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEnableUpdate, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setEnableUpdate, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, getControl, getOption, getOptions, getPage, instanceBehavior, setOption, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\ActiveControls\TBaseActiveCallbackControl

Class hierarchy