/*
* Created on Jul 31, 2007
*
* 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 @2007-2010 the original author or authors.
*/
package org.fest.swing.finder;
import java.awt.*;
import java.util.concurrent.TimeUnit;
import org.fest.swing.core.GenericTypeMatcher;
import org.fest.swing.core.Robot;
import org.fest.swing.fixture.FrameFixture;
/**
* Understands a finder for <code>{@link Frame}</code>s. This class cannot be used directly, please see
* <code>{@link WindowFinder}</code>.
*
* @author Alex Ruiz
* @author Yvonne Wang
*/
public class FrameFinder extends WindowFinderTemplate<Frame> {
/**
* Creates a new </code>{@link FrameFinder}</code>.
* @param frameName the name of the {@code Frame} to look for.
*/
protected FrameFinder(String frameName) {
super(frameName, Frame.class);
}
/**
* Creates a new </code>{@link FrameFinder}</code>.
* @param matcher specifies the search criteria to use when looking up a {@code Frame}.
*/
protected FrameFinder(GenericTypeMatcher<? extends Frame> matcher) {
super(matcher);
}
/**
* Creates a new </code>{@link FrameFinder}</code>.
* @param frameType the type of {@code Frame} to look for.
*/
protected FrameFinder(Class<? extends Frame> frameType) {
super(frameType);
}
/**
* Sets the timeout for this finder. The window to search should be found within the given time period.
* @param timeout the number of milliseconds before stopping the search.
* @return this finder.
*/
@Override public FrameFinder withTimeout(long timeout) {
super.withTimeout(timeout);
return this;
}
/**
* Sets the timeout for this finder. The window to search should be found within the given time period.
* @param timeout the period of time the search should be performed.
* @param unit the time unit for <code>timeout</code>.
* @return this finder.
*/
@Override public FrameFinder withTimeout(long timeout, TimeUnit unit) {
super.withTimeout(timeout, unit);
return this;
}
/**
* Finds a <code>{@link Frame}</code> by name or type.
* @param robot contains the underlying finding to delegate the search to.
* @return a <code>FrameFixture</code> managing the found <code>Frame</code>.
* @throws org.fest.swing.exception.WaitTimedOutError if a <code>Frame</code> could not be found.
*/
public FrameFixture using(Robot robot) {
return new FrameFixture(robot, findComponentWith(robot));
}
/**
* Casts the given {@code Component} to <code>{@link Frame}</code>.
* @return the given {@code Component}, casted to {@code Frame}.
*/
protected Frame cast(Component c) { return (Frame) c; }
}