All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.event.MacroDebugActionEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----com.ibm.eNetwork.beans.HOD.event.HODEvent
                   |
                   +----com.ibm.eNetwork.beans.HOD.event.MacroDebugActionEvent

public class MacroDebugActionEvent
extends HODEvent
Event fired to objects implementing MacroDebugListener interface (must call Macro.addMacroDebugListener). This event contains all the functionality for discovering which action is being executed.

To use this class properly, follow these steps:

  1. Implement the MacroDebugListener and add it to Macro using Macro.addMacroDebugListener.
  2. The executeAction method will be called for each action before the action is actually executed.
  3. You can get statistics about the action from the MacroDebugActionEvent class.
  4. After you have used the action data, you must return true from the executeAction method if you want the action to be executed. Returning false will skip the action.


Constructor Index

 o MacroDebugActionEvent(Macro, MacroAction, MacroActions, MacroScreen, int)
Constructs a working instance of a macro debug action event.

Method Index

 o getAction()
Returns the MacroAction object contained in the MacroActions object that happened.
 o getActionIndex()
Returns the index of the action (zero-based).
 o getActions()
Returns the MacroActions collection object that is in the MacroScreen bean.
 o getScreen()
Returns the MacroScreen to which the action belonged.
 o isExecuteAction()
Returns whether action should be executed.
 o setExecuteAction(boolean)
Sets whether action should be executed.

Constructors

 o MacroDebugActionEvent
 public MacroDebugActionEvent(Macro arg0,
                              MacroAction arg1,
                              MacroActions arg2,
                              MacroScreen arg3,
                              int arg4)
Constructs a working instance of a macro debug action event. This constructor can only be used by classes in the HOD beans package.

Methods

 o getScreen
 public MacroScreen getScreen()
Returns the MacroScreen to which the action belonged.

Returns:
MacroScreen object that was changed
See Also:
MacroScreen
 o getActions
 public MacroActions getActions()
Returns the MacroActions collection object that is in the MacroScreen bean. This method is provided for developer convenience.

Returns:
MacroActions collection object currently in the Macro bean
See Also:
MacroActions
 o getActionIndex
 public int getActionIndex()
Returns the index of the action (zero-based).

Returns:
action index in it's MacroScreen object.
 o getAction
 public MacroAction getAction()
Returns the MacroAction object contained in the MacroActions object that happened. Provided for developer convenience.

Returns:
MacroAction object in the MacroActions object that was changed
See Also:
MacroActions
 o isExecuteAction
 public boolean isExecuteAction()
Returns whether action should be executed.

Returns:
if true, Macro bean will execute the action
See Also:
MacroActions
 o setExecuteAction
 public void setExecuteAction(boolean val)
Sets whether action should be executed.

Parameters:
val - if true, Macro bean will execute the action
See Also:
MacroActions

All Packages  Class Hierarchy  This Package  Previous  Next  Index