PHP Class Prado\Web\UI\ActiveControls\TEventTriggeredCallback

Triggers a new callback request when a particular {@link setEventName EventName} on a control with ID given by {@link setControlID ControlID} is raised. The default action of the event on the client-side can be prevented when {@link setPreventDefaultAction PreventDefaultAction} is set to true.
Since: 3.1
Inheritance: extends TTriggeredCallback
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode Description
getEventName ( ) : string
getPreventDefaultAction ( ) : boolean
render ( $writer ) Registers the javascript code for initializing the active control.
setEventName ( $value ) Sets the client-side event name that fires the callback request.
setPreventDefaultAction ( $value )

Méthodes protégées

Méthode Description
getClientClassName ( ) : string
getTriggerOptions ( ) : array

Method Details

getClientClassName() protected méthode

protected getClientClassName ( ) : string
Résultat string corresponding javascript class name for TEventTriggeredCallback.

getEventName() public méthode

public getEventName ( ) : string
Résultat string The client-side event name the trigger listens to.

getPreventDefaultAction() public méthode

public getPreventDefaultAction ( ) : boolean
Résultat boolean true to prevent/stop default event action.

getTriggerOptions() protected méthode

protected getTriggerOptions ( ) : array
Résultat array list of timer options for client-side.

render() public méthode

Registers the javascript code for initializing the active control.
public render ( $writer )

setEventName() public méthode

Sets the client-side event name that fires the callback request.
public setEventName ( $value )

setPreventDefaultAction() public méthode

public setPreventDefaultAction ( $value )