Класс Robot

Этот класс используется для генерации системных событий ввода для целей автоматизации тестирования, автономных демонстраций и других приложений, где требуется управление мышью и клавиатурой. Основное назначение Robot — облегчить автоматическое тестирование реализаций Java-платформы.

Использование класса для генерации событий ввода отличается от публикации событий в очередь событий AWT или компоненты AWT тем, что события генерируются в собственной очереди ввода платформы. Например, Robot.mouseMove фактически перемещает курсор мыши, а не просто генерирует события перемещения мыши.

Обратите внимание, что некоторые платформы требуют специальных привилегий или расширений для доступа к управлению низкоуровневым вводом. Если текущая конфигурация платформы не позволяет управлять вводом, при попытке создания объектов Robot будет выброшено исключение AWTException. Например, системы X-Window выбросят исключение, если стандарт расширения XTEST 2.2 не поддерживается (или не включен) сервером X.

Приложения, использующие Robot для целей, отличных от самотестирования, должны обрабатывать эти условия ошибки надлежащим образом.

Конструкторы

Robot

public Robot()
      throws AWTException

Исключение:

AWTException - если конфигурация платформы не допускает управления низким уровнем ввода. Это исключение всегда выбрасывается, когда GraphicsEnvironment.isHeadless() возвращает true

SecurityException - если разрешение createRobot не предоставлено

См. также:

GraphicsEnvironment.isHeadless(), SecurityManager.checkPermission(java.security.Permission), AWTPermission

Robot

public Robot(GraphicsDevice screen)
      throws AWTException

Параметры:

screen - Устройство GraphicsDevice экрана, указывающее систему координат, в которой будет работать Robot.

Исключение:

AWTException - если конфигурация платформы не допускает управления низким уровнем ввода. Это исключение всегда выбрасывается, когда GraphicsEnvironment.isHeadless() возвращает true.

IllegalArgumentException - если screen не является устройством GraphicsDevice экрана.

SecurityException - если разрешение createRobot не предоставлено

См. также:

GraphicsEnvironment.isHeadless(), GraphicsDevice, SecurityManager.checkPermission(java.security.Permission), AWTPermission

Методы

mouseMove

public void mouseMove(int x,
                      int y)

Перемещает указатель мыши в заданные экранные координаты.

Параметры:

x - Позиция X

y - Позиция Y

mousePress

public void mousePress(int buttons)

Нажимает одну или несколько кнопок мыши. Кнопки мыши следует отпустить, используя метод mouseRelease(int).

Параметры:

buttons - Маска кнопки; комбинация одной или нескольких масок кнопок мыши.

Разрешается использовать только комбинацию допустимых значений в качестве параметра buttons. Допустимая комбинация состоит из InputEvent.BUTTON1_DOWN_MASK, InputEvent.BUTTON2_DOWN_MASK, InputEvent.BUTTON3_DOWN_MASK и значений, возвращаемых методом InputEvent.getMaskForButton(button). Допустимая комбинация также зависит от значения Toolkit.areExtraMouseButtonsEnabled() следующим образом:

• Если поддержка расширенных кнопок мыши disabled Java, то разрешается использовать только следующие стандартные маски кнопок: InputEvent.BUTTON1_DOWN_MASK, InputEvent.BUTTON2_DOWN_MASK, InputEvent.BUTTON3_DOWN_MASK.
• Если поддержка расширенных кнопок мыши enabled Java, то разрешается использовать стандартные маски кнопок и маски для существующих расширенных кнопок мыши, если у мыши больше трёх кнопок. Таким образом, разрешается использовать маски кнопок, соответствующие кнопкам в диапазоне от 1 до MouseInfo.getNumberOfButtons().
  Рекомендуется использовать метод InputEvent.getMaskForButton(button) для получения маски любой кнопки мыши по её номеру.

Также принимаются следующие стандартные маски кнопок:

• InputEvent.BUTTON1_MASK
• InputEvent.BUTTON2_MASK
• InputEvent.BUTTON3_MASK

Однако рекомендуется использовать InputEvent.BUTTON1_DOWN_MASK, InputEvent.BUTTON2_DOWN_MASK, InputEvent.BUTTON3_DOWN_MASK вместо них. Должны использоваться либо расширенные _DOWN_MASK, либо старые _MASK значения, но оба этих вида не следует смешивать.

Исключение:

IllegalArgumentException - если маска buttons содержит маску для дополнительной кнопки мыши, и поддержка расширенных кнопок мыши disabled Java

IllegalArgumentException - если маска buttons содержит маску для дополнительной кнопки мыши, которая не существует на мыши, и поддержка расширенных кнопок мыши enabled Java

См. также:

mouseRelease(int), InputEvent.getMaskForButton(int), Toolkit.areExtraMouseButtonsEnabled(), MouseInfo.getNumberOfButtons(), MouseEvent

mouseRelease

public void mouseRelease(int buttons)

Отпускает одну или несколько кнопок мыши.

Параметры:

buttons - Маска кнопки; комбинация одной или нескольких масок кнопок мыши.

Разрешается использовать только комбинацию допустимых значений в качестве параметра buttons. Допустимая комбинация состоит из InputEvent.BUTTON1_DOWN_MASK, InputEvent.BUTTON2_DOWN_MASK, InputEvent.BUTTON3_DOWN_MASK и значений, возвращаемых методом InputEvent.getMaskForButton(button). Допустимая комбинация также зависит от значения Toolkit.areExtraMouseButtonsEnabled() следующим образом:

• Если поддержка расширенных кнопок мыши disabled Java, то разрешается использовать только следующие стандартные маски кнопок: InputEvent.BUTTON1_DOWN_MASK, InputEvent.BUTTON2_DOWN_MASK, InputEvent.BUTTON3_DOWN_MASK.
• Если поддержка расширенных кнопок мыши enabled Java, то разрешается использовать стандартные маски кнопок и маски для существующих расширенных кнопок мыши, если у мыши больше трёх кнопок. Таким образом, разрешается использовать маски кнопок, соответствующие кнопкам в диапазоне от 1 до MouseInfo.getNumberOfButtons().
  Рекомендуется использовать метод InputEvent.getMaskForButton(button) для получения маски любой кнопки мыши по её номеру.

Также принимаются следующие стандартные маски кнопок:

• InputEvent.BUTTON1_MASK
• InputEvent.BUTTON2_MASK
• InputEvent.BUTTON3_MASK

Однако рекомендуется использовать InputEvent.BUTTON1_DOWN_MASK, InputEvent.BUTTON2_DOWN_MASK, InputEvent.BUTTON3_DOWN_MASK вместо них. Должны использоваться либо расширенные _DOWN_MASK, либо старые _MASK значения, но оба этих вида не следует смешивать.

Исключение:

IllegalArgumentException - если маска buttons содержит маску для дополнительной кнопки мыши, и поддержка расширенных кнопок мыши disabled Java

IllegalArgumentException - если маска buttons содержит маску для дополнительной кнопки мыши, которая не существует на мыши, и поддержка расширенных кнопок мыши enabled Java

См. также:

mousePress(int), InputEvent.getMaskForButton(int), Toolkit.areExtraMouseButtonsEnabled(), MouseInfo.getNumberOfButtons(), MouseEvent

mouseWheel

public void mouseWheel(int wheelAmt)

Поворачивает колесо прокрутки на мышах с колесом прокрутки.

Параметры:

wheelAmt - количество «делений» для перемещения колеса мыши. Отрицательные значения обозначают движение вверх/от пользователя, положительные значения обозначают движение вниз/к пользователю.

С:

1.4

keyPress

public void keyPress(int keycode)

Параметры:

keycode - Клавиша для нажатия (например, KeyEvent.VK_A)

Исключение:

IllegalArgumentException - если keycode не является допустимой клавишей

См. также:

keyRelease(int), KeyEvent

keyRelease

public void keyRelease(int keycode)

Параметры:

keycode - Клавиша для отпускания (например, KeyEvent.VK_A)

Исключение:

IllegalArgumentException - если keycode не является допустимой клавишей

См. также:

keyPress(int), KeyEvent

getPixelColor

public Color getPixelColor(int x,
                           int y)

Возвращает цвет пикселя в заданных экранных координатах.

Параметры:

x - Позиция X пикселя

y - Позиция Y пикселя

Возвращает:

Цвет пикселя

createScreenCapture

public BufferedImage createScreenCapture(Rectangle screenRect)

Создаёт изображение, содержащее пиксели, прочитанные с экрана. Это изображение не включает курсор мыши.

Параметры:

screenRect - Прямоугольник для захвата в экранных координатах

Возвращает:

Захваченное изображение

Исключение:

IllegalArgumentException - если ширина и высота screenRect не больше нуля

SecurityException - если разрешение readDisplayPixels не предоставлено

См. также:

SecurityManager.checkPermission(java.security.Permission), AWTPermission

isAutoWaitForIdle

public boolean isAutoWaitForIdle()

Возвращает, вызывает ли этот объект Robot автоматически waitForIdle после генерации события.

Возвращает:

Вызывается ли waitForIdle автоматически

setAutoWaitForIdle

public void setAutoWaitForIdle(boolean isOn)

Устанавливает, вызывает ли этот объект Robot автоматически waitForIdle после генерации события.

Параметры:

isOn - Вызывается ли waitForIdle автоматически

getAutoDelay

public int getAutoDelay()

Возвращает количество миллисекунд, которое этот объект Robot ожидает после генерации события.

setAutoDelay

public void setAutoDelay(int ms)

Устанавливает количество миллисекунд, которое этот объект Robot ожидает после генерации события.

Исключение:

IllegalArgumentException - Если ms не находится в диапазоне от 0 до 60 000 миллисекунд включительно

delay

public void delay(int ms)

Ожидает указанное время. Для перехвата любых InterruptedException используйте метод Thread.sleep().

Параметры:

ms - время ожидания в миллисекундах

Исключение:

IllegalArgumentException - если ms не находится в диапазоне от 0 до 60 000 миллисекунд включительно

См. также:

Thread.sleep(long)

waitForIdle

public void waitForIdle()

Ожидает, пока все события в очереди будут обработаны.

Исключение:

IllegalThreadStateException - если вызывается на потоке обработки событий AWT

toString

public String toString()

Возвращает строковое представление этого объекта Robot.

Переопределяет:

toString в классе Object

Возвращает:

строковое представление.