org.assertj.swing.driver

Class ComponentShownWaiter

java.lang.Object

java.awt.event.ComponentAdapter

org.assertj.swing.driver.ComponentShownWaiter

All Implemented Interfaces:

ComponentListener, EventListener

public final class ComponentShownWaiter
extends ComponentAdapter

Waits until a particular AWT or Swing Component shows up on the screen.

Author:

Alex Ruiz

Method Summary

Methods

Modifier and Type	Method and Description
void	componentShown(ComponentEvent e) Notification that the AWT or Swing Component to wait for is finally shown on the screen.
static void	waitTillShown(Component toWaitFor) Waits until the given AWT or Swing Component is shown on the screen, using a timeout of 5 seconds.
static void	waitTillShown(Component toWaitFor, long timeout) Waits until the given AWT or Swing Component is shown on the screen.

Methods inherited from class java.awt.event.ComponentAdapter

componentHidden, componentMoved, componentResized

Methods inherited from class java.lang.Object

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

Method Detail

waitTillShown

public static void waitTillShown(@Nonnull
                 Component toWaitFor)

Waits until the given AWT or Swing Component is shown on the screen, using a timeout of 5 seconds.

Parameters:

toWaitFor - the Component to wait for.

Throws:

WaitTimedOutError - if the Component is not shown before the default timeout of 5 seconds.

waitTillShown

public static void waitTillShown(@Nonnull
                 Component toWaitFor,
                 long timeout)

Waits until the given AWT or Swing Component is shown on the screen.

Parameters:

toWaitFor - the Component to wait for.

timeout - the amount to time (in milliseconds) to wait for the Component to be shown.

Throws:

WaitTimedOutError - if the Component is not shown before the given timeout expires.

componentShown

@RunsInEDT
public void componentShown(@Nullable
                            ComponentEvent e)

Notification that the AWT or Swing Component to wait for is finally shown on the screen.

Specified by:

componentShown in interface ComponentListener

Overrides:

componentShown in class ComponentAdapter

Parameters:

e - the event raised when the Component has been made visible.