org.assertj.swing.finder

Class DialogFinder

java.lang.Object

org.assertj.swing.finder.ComponentFinderTemplate<T>

org.assertj.swing.finder.WindowFinderTemplate<Dialog>

org.assertj.swing.finder.DialogFinder

public class DialogFinder
extends WindowFinderTemplate<Dialog>

Finder for AWT or Swing Dialogs. This class cannot be used directly, please see WindowFinder.

Author:

Yvonne Wang, Alex Ruiz

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DialogFinder(Class<? extends Dialog> dialogType) Creates a new DialogFinder.
protected	DialogFinder(GenericTypeMatcher<? extends Dialog> matcher) Creates a new DialogFinder.
protected	DialogFinder(String dialogName) Creates a new DialogFinder.

Method Summary

Methods

Modifier and Type	Method and Description
protected Dialog	cast(Component c) Casts the given AWT or Swing Component to Dialog.
DialogFixture	using(Robot robot) Finds a Dialog by name or type.
DialogFinder	withTimeout(long timeout) Sets the timeout for this finder.
DialogFinder	withTimeout(long timeout, TimeUnit unit) Sets the timeout for this finder.

Methods inherited from class org.assertj.swing.finder.ComponentFinderTemplate

findComponentWith

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialogFinder

protected DialogFinder(@Nullable
            String dialogName)

Creates a new DialogFinder.

Parameters:

dialogName - the name of the Dialog to look for.

DialogFinder

protected DialogFinder(@Nonnull
            GenericTypeMatcher<? extends Dialog> matcher)

Creates a new DialogFinder.

Parameters:

matcher - specifies the search criteria to use when looking up a Dialog.

DialogFinder

protected DialogFinder(@Nonnull
            Class<? extends Dialog> dialogType)

Creates a new DialogFinder.

Parameters:

dialogType - the type of Dialog to look for.

Method Detail

withTimeout

@Nonnull
public DialogFinder withTimeout(@Nonnegative
                               long timeout)

Sets the timeout for this finder. The window to search should be found within the given time period.

Overrides:

withTimeout in class WindowFinderTemplate<Dialog>

Parameters:

timeout - the number of milliseconds before stopping the search.

Returns:

this finder.

withTimeout

@Nonnull
public DialogFinder withTimeout(@Nonnegative
                               long timeout,
                               @Nonnull
                               TimeUnit unit)

Sets the timeout for this finder. The window to search should be found within the given time period.

Overrides:

withTimeout in class WindowFinderTemplate<Dialog>

Parameters:

timeout - the period of time the search should be performed.

unit - the time unit for timeout.

Returns:

this finder.

using

@Nonnull
public DialogFixture using(@Nonnull
                          Robot robot)

Finds a Dialog by name or type.

Specified by:

using in class WindowFinderTemplate<Dialog>

Parameters:

robot - contains the underlying finding to delegate the search to.

Returns:

a DialogFixture managing the found Dialog.

Throws:

WaitTimedOutError - if a Dialog could not be found.

cast

@Nullable
protected Dialog cast(@Nullable
                   Component c)

Casts the given AWT or Swing Component to Dialog.

Specified by:

cast in class ComponentFinderTemplate<Dialog>

Parameters:

c - the given Component.

Returns:

the given Component, casted to Dialog.