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

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.eNetwork.beans.HOD.event.HODEvent
              |
              +--com.ibm.eNetwork.beans.HOD.event.MacroDebugActionEvent
All Implemented Interfaces:
java.io.Serializable

public class MacroDebugActionEvent
extends com.ibm.eNetwork.beans.HOD.event.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.

See Also:
Serialized Form

Constructor Summary
MacroDebugActionEvent(Macro arg0, MacroAction arg1, MacroActions arg2, MacroScreen arg3, int arg4)
          Constructs a working instance of a macro debug action event.
 
Method Summary
 MacroAction getAction()
          Returns the MacroAction object contained in the MacroActions object that happened.
 int getActionIndex()
          Returns the index of the action (zero-based).
 MacroActions getActions()
          Returns the MacroActions collection object that is in the MacroScreen bean.
 MacroScreen getScreen()
          Returns the MacroScreen to which the action belonged.
 boolean isExecuteAction()
          Returns whether action should be executed.
 void setExecuteAction(boolean val)
          Sets whether action should be executed.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

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.
Method Detail

getScreen

public MacroScreen getScreen()
Returns the MacroScreen to which the action belonged.
Returns:
MacroScreen object that was changed
See Also:
MacroScreen

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

getActionIndex

public int getActionIndex()
Returns the index of the action (zero-based).
Returns:
action index in it's MacroScreen object.

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

isExecuteAction

public boolean isExecuteAction()
Returns whether action should be executed.
Returns:
if true, Macro bean will execute the action
See Also:
MacroActions

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