Package org.sikuli.script

Class ObserverCallBack

java.lang.Object
org.sikuli.script.ObserverCallBack
All Implemented Interfaces:
EventListener
public class ObserverCallBack
extends Object
implements EventListener
Use this class to implement callbacks for
the Region observers onAppear, onVanish and onChange.
by overriding the respective methods appeared(ObserveEvent), vanished(ObserveEvent), changed(ObserveEvent)
see: Region.onAppear(Object, Object), Region.onVanish(Object, Object), Region.onChange(Object)}
and the handling of FindFailed and ImageMissing by overriding findfailed(ObserveEvent) or missing(ObserveEvent)
see: Region.setFindFailedHandler(Object), Element.setImageMissingHandler(Object) 
 // example (called when image appears):
 aRegion.onAppear(anImageOrPattern,
   new ObserverCallBack() {
     appeared(ObserveEvent e) {
       // do something
     }
   }
 );
see ObserveEvent about the features available in the callback function

  • Constructor Details

    • ObserverCallBack

      public ObserverCallBack()
      setup a callback to be used on the Java API level 
       // example (called when image appears):
 aRegion.onAppear(anImageOrPattern,
   new ObserverCallBack() {
     appeared(ObserveEvent e) {
       // do something
     }
   }
 );

    • ObserverCallBack

      public ObserverCallBack​(Object callback, ObserveEvent.Type obsType)
      INTERNAL: callbacks from Jython or JRuby
      Parameters:
      callback - funtion to call
      obsType - observer type

  • Method Details

    • setType

      public void setType​(ObserveEvent.Type givenType)
      INTERNAL USE
      Parameters:
      givenType - observer type

    • getType

      public ObserveEvent.Type getType()
      INTERNAL USE
      Returns:
      observer type

    • appeared

      public void appeared​(ObserveEvent event)
      to be overwritten to handle appear events
      Parameters:
      event - that happened

    • vanished

      public void vanished​(ObserveEvent event)
      to be overwritten to handle vanish events
      Parameters:
      event - that happened

    • changed

      public void changed​(ObserveEvent event)
      to be overwritten to handle changed events
      Parameters:
      event - that happened

    • findfailed

      public void findfailed​(ObserveEvent event)
      to be overwritten to handle FindFailed events
      Parameters:
      event - that happened

    • missing

      public void missing​(ObserveEvent event)
      to be overwritten to handle image missing events
      Parameters:
      event - that happened

    • happened

      public void happened​(ObserveEvent event)
      to be overwritten to handle generic events
      Parameters:
      event - that happened