Class MOXMAN_Util_EventArgs

All Classes | Methods

Inheritance	MOXMAN_Util_EventArgs
Subclasses	MOXMAN_Vfs_CustomInfoEventArgs, MOXMAN_Vfs_FileActionEventArgs, MOXMAN_Vfs_StreamEventArgs

Base class for the event args classes. This has the basic core logic for an event and is supposed to be extended by custom events.

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()	Constructs a new EventArgs instance.	MOXMAN_Util_EventArgs
cancel()	Cancels the action to be executed after the event. This is normally used in events called just before an action is to be performed.	MOXMAN_Util_EventArgs
getSender()	Returns the sender instance that dispatched the event.	MOXMAN_Util_EventArgs
isCancelled()	Returns true/false if the event is cancelled or not. This will block the action followed by the event. This is normally used to cancel an action on a event called before the action.	MOXMAN_Util_EventArgs
isStopped()	Returns true/false if the event is stopped. If it's stopped other event handlers won't be executed.	MOXMAN_Util_EventArgs
setSender()	Sets the sender that dispatched the event.	MOXMAN_Util_EventArgs
stop()	Stops the event from being passed to other event handlers.	MOXMAN_Util_EventArgs

Method Details

__construct() public method

Constructs a new EventArgs instance.

public void __construct ( )

cancel() public method

Cancels the action to be executed after the event. This is normally used in events called just before an action is to be performed.

public void cancel ( )

getSender() public method

Returns the sender instance that dispatched the event.

public Object getSender ( )
return	Object	Sender instance reference that dispatched the event.

isCancelled() public method

Returns true/false if the event is cancelled or not. This will block the action followed by the event. This is normally used to cancel an action on a event called before the action.

public Bool isCancelled ( )
return	Bool	State if the event was cancelled or not.

isStopped() public method

Returns true/false if the event is stopped. If it's stopped other event handlers won't be executed.

public Boolean isStopped ( )
return	Boolean	True/false if the event is stopped from being passed to other event handlers.

setSender() public method

Sets the sender that dispatched the event.

public void setSender ( $sender )
$sender	Object	Sender instance to set.

stop() public method

Stops the event from being passed to other event handlers.

public void stop ( )