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

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

public class MacroLoopEvent
extends com.ibm.eNetwork.beans.HOD.event.HODEvent

MacroLoopEvent is fired to MacroLoopListeners by Macro once for each screen in a macro if the screen has a positive recognition limit value. It allows you to dynamically set the loop limit for each screen that has a recolimit line in it.

When you receive this event, call the getScreen() method to set your desired loop limit. This loop limit corresponds to the value attribute of the recolimit element.

Screens in the macro that have a recognition limit of 0 or lower are ignored and not fired in this event.

See Also:
MacroLoopListener, Serialized Form

Constructor Summary
MacroLoopEvent(Macro src, MacroScreen scrn)
          Constructs a new MacroLoopEvent object.
 
Method Summary
 MacroScreen getScreen()
          Retrieve the MacroScreen object from the event.
 
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

MacroLoopEvent

public MacroLoopEvent(Macro src,
                      MacroScreen scrn)
Constructs a new MacroLoopEvent object.
Method Detail

getScreen

public MacroScreen getScreen()
Retrieve the MacroScreen object from the event. You may change the looping limit by calling MacroScreen.setRecoLimit(int). Screens in the macro that have a recognition limit of 0 or lower are ignored and not fired in this event.
Returns:
MacroScreen object that you use to set the loop limit
See Also:
MacroScreen