Class MOXMAN_Util_EventArgs
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
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
Constructs a new EventArgs instance.
public void __construct ( ) |
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 ( ) |
Returns the sender instance that dispatched the event.
public Object getSender ( ) | ||
return | Object | Sender instance reference that dispatched the event. |
---|
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. |
---|
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. |
---|
Sets the sender that dispatched the event.
public void setSender ( $sender ) | ||
$sender | Object | Sender instance to set. |
Stops the event from being passed to other event handlers.
public void stop ( ) |