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

Datei anzeigen Open project: pradosoft/prado

Public Methods

Method	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 )

Protected Methods

Method	Description
getClientClassName ( ) : string
getTriggerOptions ( ) : array

Method Details

getClientClassName() protected method

protected getClientClassName ( ) : string
return	string	corresponding javascript class name for TEventTriggeredCallback.

getEventName() public method

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

getPreventDefaultAction() public method

public getPreventDefaultAction ( ) : boolean
return	boolean	true to prevent/stop default event action.

getTriggerOptions() protected method

protected getTriggerOptions ( ) : array
return	array	list of timer options for client-side.

render() public method

Registers the javascript code for initializing the active control.

public render ( $writer )

setEventName() public method

Sets the client-side event name that fires the callback request.

public setEventName ( $value )

setPreventDefaultAction() public method

public setPreventDefaultAction ( $value )