org.assertj.swing.driver.DialogDriver 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

Fluent interface for functional GUI testing

There is a newer version: 3.17.1

/**
 * 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-2015 the original author or authors.
 */
package org.assertj.swing.driver;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.swing.driver.DialogModalQuery.isModal;

import java.awt.Dialog;

import javax.annotation.Nonnull;

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 Dialog}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 DialogDriver extends WindowDriver {
  /**
   * Creates a new {@link DialogDriver}.
   * 
   * @param robot the robot to use to simulate user input.
   */
  public DialogDriver(@Nonnull Robot robot) {
    super(robot);
  }

  /**
   * Asserts that the given AWT or Swing {@code Dialog} is modal.
   * 
   * @param dialog the given {@code Dialog}.
   * @throws AssertionError if the given {@code Dialog} is not modal.
   */
  @RunsInEDT
  public void requireModal(@Nonnull Dialog dialog) {
    assertThat(isModal(dialog)).as(propertyName(dialog, "modal")).isTrue();
  }
}