com.ibm.eNetwork.ECL.screenreco.event
Class ECLCustomRecoEvent

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.screenreco.event.ECLCustomRecoEvent

public class ECLCustomRecoEvent
extends java.lang.Object

This event class is passed to a MacroCustomRecoListener registered on an ECLScreenReco object. The custom screen recognition event/listener classes can be to extend the recognition functionality of the Host Access Class Library screen recognition to whatever you wish. This class is passed in the ECLCustomRecoListener.doReco event.

See Also:
ECLCustomRecoListener

Constructor Summary
ECLCustomRecoEvent(java.lang.String id, ECLPS ps, ECLScreenDesc sd)
          Constructs a working instance of a custom recognition event.
 
Method Summary
 java.lang.String getID()
          Returns the ID string for the custom recognition descriptor.
 ECLPS GetPS()
          Returns the presentation space object that ECLScreenReco is using.
 ECLScreenDesc GetScreenDesc()
          Returns the ECLScreenDesc object that ECLScreenReco is comparing against the presentation space.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ECLCustomRecoEvent

public ECLCustomRecoEvent(java.lang.String id,
                          ECLPS ps,
                          ECLScreenDesc sd)
Constructs a working instance of a custom recognition event. This constructor can only be used by classes in the HOD beans package.
Method Detail

getID

public java.lang.String getID()
Returns the ID string for the custom recognition descriptor. Use it to give you a context.
Returns:
identification string for the custom recognition descriptor

GetPS

public ECLPS GetPS()
Returns the presentation space object that ECLScreenReco is using.
Returns:
ECLPS object that ECLScreenReco is using

GetScreenDesc

public ECLScreenDesc GetScreenDesc()
Returns the ECLScreenDesc object that ECLScreenReco is comparing against the presentation space.
Returns:
ECLScreenDesc object being compared