org.assertj.swing.conditions.ComponentVisibleCondition Maven / Gradle / Ivy

Go to download
/*
 * 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.conditions;

import java.awt.Component;

import org.assertj.swing.core.BasicComponentFinder;
import org.assertj.swing.core.ComponentFinder;
import org.assertj.swing.core.ComponentMatcher;
import org.assertj.swing.core.NameMatcher;
import org.assertj.swing.exception.ComponentLookupException;
import org.assertj.swing.timing.Condition;

/**
 * A Condition that requires a component to be visible.
 * 
 * @author Peter Murray
 */
public class ComponentVisibleCondition extends Condition {

  private final ComponentFinder _finder;

  private final ComponentMatcher _matcher;

  private Component _found;

  /**
   * Creates a new {@link ComponentVisibleCondition}
   * 
   * @param name The name of the component to find.
   * @param type The type of the component to find.
   */
  public ComponentVisibleCondition(String name, Class type) {
	this(BasicComponentFinder.finderWithCurrentAwtHierarchy(),
	     new NameMatcher(name, type, true));
  }

  /**
   * Creates a new {@link ComponentVisibleCondition}
   * 
   * @param name The name of the component to find.
   */
  public ComponentVisibleCondition(String name) {
	this(BasicComponentFinder.finderWithCurrentAwtHierarchy(),
	     new NameMatcher(name, true));
  }

  /**
   * Creates a new {@link ComponentVisibleCondition}
   * 
   * @param finder performs the component search.
   * @param matcher specifies the condition that the component we are looking for needs to
   *          match.
   */
  public ComponentVisibleCondition(ComponentFinder finder,
	                               ComponentMatcher matcher) {
	this("Component Visible Condition", finder, matcher);
  }

  /**
   * Creates a new {@link ComponentVisibleCondition}
   * 
   * @param description the description of this condition.
   * @param finder performs the component search.
   * @param matcher specifies the condition that the component we are looking for needs to
   *          match.
   */
  public ComponentVisibleCondition(String description,
	                               ComponentFinder finder,
	                               ComponentMatcher matcher) {
	super(description);
	_finder = finder;
	_matcher = matcher;
  }

  /**
   * Returns true if a component that matches the search criteria in this
   * condition's {@link org.assertj.swing.core.ComponentMatcher} can be found. Otherwise, this
   * method returns false.
   * 
   * @return true if a matching component can be found, false otherwise.
   */
  @Override
  public boolean test() {
	try {
	  _found = _finder.find(_matcher);
	  return _found.isVisible();
	} catch (ComponentLookupException e) {
	}
	return false;
  }

  public Component found() {
	return _found;
  }
}