PHP Class Prado\Web\UI\ActiveControls\TBaseActiveCallbackControl

The properties of TBaseActiveCallbackControl can be accessed and changed from each individual active controls' {@link getActiveControl ActiveControl} property. The following example sets the validation group property of a TCallback component.

Additional client-side options and events can be set using the {@link getClientSide ClientSide} property. The following example shows an alert box when a TCallback component response returns successfully.

Since: 3.1

Inheritance: extends TBaseActiveControl

Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode	Description
canCauseValidation ( ) : boolean
getCallbackOptions ( ) : string
getCallbackParameter ( ) : mixed
getCausesValidation ( ) : boolean
getClientSide ( ) : TCallbackClientSide	Callback client-side options can be set by setting the properties of the ClientSide property. E.g.
getJavascript ( ) : string	Returns the javascript callback request instance. To invoke a callback request for this control call the `dispatch()` method on the request instance. Example code in javascript `var request = <%= $this->mycallback->ActiveControl->Javascript %>; request.setParameter('hello'); request.dispatch(); //make the callback request.`
getJsCallbackOptions ( )
getValidationGroup ( ) : string
registerCallbackClientScript ( $class, $options = null )	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 {@link getClientSide ClientSide} property.
setCallbackOptions ( $value )	Sets default callback options. Takes the ID of a TCallbackOptions component to duplicate the client-side options for this control. The {@link getClientSide ClientSide} subproperties takes precedence over the CallbackOptions property.
setCallbackParameter ( $value )
setCausesValidation ( $value )
setClientSide ( $client )	Sets the client side options. Can only be set when client side is null.
setValidationGroup ( $value )

Méthodes protégées

Méthode	Description
createClientSide ( ) : TCallbackClientSide
getClientSideOptions ( ) : array
getDefaultClientSideOptions ( ) : array	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 {@link setCallbackOptions CallbackOptions}.

Method Details

canCauseValidation() public méthode

public canCauseValidation ( ) : boolean
Résultat	boolean	whether to perform validation if the callback is requested.

createClientSide() protected méthode

protected createClientSide ( ) : TCallbackClientSide
Résultat	TCallbackClientSide	callback client-side options.

getCallbackOptions() public méthode

public getCallbackOptions ( ) : string
Résultat	string	ID of a TCallbackOptions control from which ClientSide options are duplicated.

getCallbackParameter() public méthode

public getCallbackParameter ( ) : mixed
Résultat	mixed	callback parameter value.

getCausesValidation() public méthode

public getCausesValidation ( ) : boolean
Résultat	boolean	whether callback event trigger by this button will cause input validation, default is true

getClientSide() public méthode

.." /> See {@link TCallbackClientSide} for details on the properties of ClientSide.

public getClientSide ( ) : TCallbackClientSide
Résultat	TCallbackClientSide	client-side callback options.

getClientSideOptions() protected méthode

protected getClientSideOptions ( ) : array
Résultat	array	list of callback javascript options.

getDefaultClientSideOptions() protected méthode

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 {@link setCallbackOptions CallbackOptions}.

protected getDefaultClientSideOptions ( ) : array
Résultat	array	list of default callback client-side options.

getJavascript() public méthode

Alternatively,


dispatches immediately
Prado.Callback("<%= $this->mycallback->UniqueID %>",
   $this->mycallback->ActiveControl->JsCallbackOptions);

public getJavascript ( ) : string
Résultat	string	javascript client-side callback request object (javascript code)

getJsCallbackOptions() public méthode

public getJsCallbackOptions ( )

getValidationGroup() public méthode

public getValidationGroup ( ) : string
Résultat	string	the group of validators which the button causes validation upon callback

registerCallbackClientScript() public méthode

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 {@link getClientSide ClientSide} property.

public registerCallbackClientScript ( $class, $options = null )

setCallbackOptions() public méthode

Sets default callback options. Takes the ID of a TCallbackOptions component to duplicate the client-side options for this control. The {@link getClientSide ClientSide} subproperties takes precedence over the CallbackOptions property.

public setCallbackOptions ( $value )

setCallbackParameter() public méthode

public setCallbackParameter ( $value )

setCausesValidation() public méthode

public setCausesValidation ( $value )

setClientSide() public méthode

Sets the client side options. Can only be set when client side is null.

public setClientSide ( $client )

setValidationGroup() public méthode

public setValidationGroup ( $value )