org.assertj.swing.driver.WindowDriver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of assertj-swing Show documentation
Assertj-Swing test framework
The newest version!
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * Copyright 2012-2018 the original author or authors.
 */
package org.assertj.swing.driver;

import static org.assertj.core.util.Preconditions.checkNotNull;
import static org.assertj.swing.driver.ComponentPreconditions.checkEnabledAndShowing;
import static org.assertj.swing.driver.WindowLikeContainers.closeButtonLocation;
import static org.assertj.swing.edt.GuiActionRunner.execute;

import java.awt.Dimension;
import java.awt.Point;
import java.awt.Window;

import org.jetbrains.annotations.NotNull;

import org.assertj.swing.annotation.RunsInEDT;
import org.assertj.swing.core.Robot;
import org.assertj.swing.internal.annotation.InternalApi;

/**
 * 
 * Supports functional testing of AWT or Swing {@code Window}s.
 * 
 *
 * 
 * Note: This class is intended for internal use only. Please use the classes in the package
 * {@link org.assertj.swing.fixture} in your tests.
 * 
 *
 * @author Alex Ruiz
 */
@InternalApi
public class WindowDriver extends ContainerDriver {
  /**
   * Creates a new {@link WindowDriver}.
   *
   * @param robot the robot to use to simulate user input.
   */
  public WindowDriver(@NotNull Robot robot) {
    super(robot);
  }

  /**
   * Resizes the {@code Window} horizontally.
   *
   * @param w the target {@code Window}.
   * @param width the width that the {@code Window} should have after being resized.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not enabled.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not resizable by the user.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not showing on the screen.
   */
  @RunsInEDT
  public void resizeWidthTo(@NotNull Window w, int width) {
    doResizeWidth(w, width);
  }

  /**
   * Resizes the {@code Window} vertically.
   *
   * @param w the target {@code Window}.
   * @param height the height that the {@code Window} should have after being resized.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not enabled.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not resizable by the user.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not showing on the screen.
   */
  @RunsInEDT
  public void resizeHeightTo(@NotNull Window w, int height) {
    doResizeHeight(w, height);
  }

  /**
   * Resizes the {@code Window} to the given size.
   *
   * @param w the target {@code Window}.
   * @param size the size to resize the {@code Window} to.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not enabled.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not resizable by the user.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not showing on the screen.
   */
  @RunsInEDT
  public void resizeTo(@NotNull Window w, @NotNull Dimension size) {
    resize(w, size.width, size.height);
  }

  /**
   * Moves the {@code Window} to the given location.
   *
   * @param w the target {@code Window}.
   * @param where the location to move the {@code Window} to.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not enabled.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not movable by the user.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not showing on the screen.
   */
  public void moveTo(@NotNull Window w, @NotNull Point where) {
    move(w, where.x, where.y);
  }

  /**
   * Closing the {@code Window}.
   *
   * @param w the target {@code Window}.
   * @throws org.assertj.swing.exception.ActionFailedException if the {@code Window} is not enabled. Or if the
   *           {@code Window} is not showing on the screen.
   */
  @RunsInEDT
  public void close(@NotNull Window w) {
    moveMouseIgnoringAnyError(w, closeInfo(w));
    robot.close(w);
  }

  @RunsInEDT
  @NotNull
  private static Point closeInfo(final @NotNull Window w) {
    Point result = execute(() -> {
      checkEnabledAndShowing(w);
      return closeButtonLocation(w);
    });
    return checkNotNull(result);
  }

  /**
   * Shows the {@code Window}.
   *
   * @param w the target {@code Window}.
   */
  @RunsInEDT
  public void show(@NotNull Window w) {
    robot.showWindow(w);
  }

  /**
   * Shows the {@code Window}, resized to the given size.
   *
   * @param w the target {@code Window}.
   * @param size the size to resize the {@code Window} to.
   */
  @RunsInEDT
  public void show(@NotNull Window w, @NotNull Dimension size) {
    robot.showWindow(w, size);
  }

  /**
   * If the given {@code Window} is visible, brings it to the front and may make it the focused one.
   *
   * @param w the target {@code Window}.
   */
  @RunsInEDT
  public void moveToFront(@NotNull Window w) {
    doMoveToFront(w);
    robot.waitForIdle();
  }

  @RunsInEDT
  private static void doMoveToFront(final @NotNull Window w) {
    execute(() -> w.toFront());
  }

  /**
   * If the given {@code Window} is visible, sends it to the back and may cause it to lose focus or activation if it is
   * the focused or active.
   *
   * @param w the target {@code Window}.
   */
  @RunsInEDT
  public void moveToBack(@NotNull Window w) {
    doMoveToBack(w);
    robot.waitForIdle();
  }

  @RunsInEDT
  private static void doMoveToBack(final @NotNull Window w) {
    execute(() -> w.toBack());
  }
}