Class SHAFT.GUI.SikuliX

java.lang.Object
com.shaft.driver.SHAFT.GUI.SikuliX
Enclosing class:
SHAFT.GUI
public static class SHAFT.GUI.SikuliX extends Object
Entry point for optional SikuliX image-based desktop automation.

Add io.github.shafthq:shaft-sikulix to the project before creating this class. Without that optional module SHAFT throws a dependency-specific error instead of a generic class loading failure.

  • Constructor Details

    • SikuliX

      public SikuliX()
      Creates SikuliX actions for the current desktop screen.
      Throws:
      IllegalStateException - when shaft-sikulix is missing

    • SikuliX

      public SikuliX(String applicationName)
      Attaches to an opened desktop application window by name or partial name.
      Parameters:
      applicationName - name or partial name of the target application window
      Throws:
      IllegalStateException - when shaft-sikulix is missing

  • Method Details

    • getInstance

      public static SHAFT.GUI.SikuliX getInstance(String applicationName)
      Creates a SikuliX driver attached to an opened desktop application window.
      Parameters:
      applicationName - name or partial name of the target application window
      Returns:
      a SikuliX driver facade

    • quit

      public void quit()
      Closes the attached desktop application window.

    • element

      public SHAFT.GUI.SikuliX.SikuliActions element()
      Returns a SikuliX action facade.
      Returns:
      SikuliX action facade

    • getDriver

      public Object getDriver()
      Returns the native SikuliX app handle, or null for screen-only actions.
      Returns:
      native SikuliX app handle