Package org.openqa.selenium

Interface WebDriver.ImeHandler

  • Enclosing interface:
    WebDriver
    public static interface WebDriver.ImeHandler
    An interface for managing input methods.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void activateEngine​(java.lang.String engine)
      Make an engines that is available (appears on the list returned by getAvailableEngines) active.
      void deactivate()
      De-activate IME input (turns off the currently activated engine).
      java.lang.String getActiveEngine()
      Get the name of the active IME engine.
      java.util.List<java.lang.String> getAvailableEngines()
      All available engines on the machine.
      boolean isActivated()
      Indicates whether IME input active at the moment (not if it's available).

    • Method Detail

      • getAvailableEngines

        java.util.List<java.lang.String> getAvailableEngines()
        All available engines on the machine. To use an engine, it has to be activated.
        Returns:
        list of available IME engines.
        Throws:
        ImeNotAvailableException - if the host does not support IME.

      • getActiveEngine

        java.lang.String getActiveEngine()
        Get the name of the active IME engine. The name string is platform-specific.
        Returns:
        name of the active IME engine.
        Throws:
        ImeNotAvailableException - if the host does not support IME.

      • isActivated

        boolean isActivated()
        Indicates whether IME input active at the moment (not if it's available).
        Returns:
        true if IME input is available and currently active, false otherwise.
        Throws:
        ImeNotAvailableException - if the host does not support IME.

      • deactivate

        void deactivate()
        De-activate IME input (turns off the currently activated engine). Note that getActiveEngine may still return the name of the engine but isActivated will return false.
        Throws:
        ImeNotAvailableException - if the host does not support IME.

      • activateEngine

        void activateEngine​(java.lang.String engine)
        Make an engines that is available (appears on the list returned by getAvailableEngines) active. After this call, the only loaded engine on the IME daemon will be this one and the input sent using sendKeys will be converted by the engine. Note that this is a platform-independent method of activating IME (the platform-specific way being using keyboard shortcuts).
        Parameters:
        engine - name of engine to activate.
        Throws:
        ImeNotAvailableException - if the host does not support IME.
        ImeActivationFailedException - if the engine is not available or if activation failed for other reasons.