java.lang.Object
- org.netbeans.jemmy.Waiter
- - org.netbeans.jemmy.WindowWaiter

All Implemented Interfaces:

Outputable, Timeoutable, Waitable

Direct Known Subclasses:

DialogWaiter, FrameWaiter
```
public class WindowWaiter
extends Waiter
implements Timeoutable
```
A WindowWaiter is a utility class used to look or wait for Windows. It contains methods to search for a Window among the currently showing Windows as well as methods that wait for a Window to show within an allotted time period. Searches and waits always involve search criteria applied by a ComponentChooser instance. Searches and waits can both be restricted to windows owned by a given window.
Timeouts used:
WindowWaiter.WaitWindowTimeout - time to wait window displayed
WindowWaiter.AfterWindowTimeout - time to sleep after window has been dispayed

Author:

Alexandre Iline (alexandre.iline@sun.com)

See Also:

Timeouts

Constructor Summary

Constructors
Constructor Description

WindowWaiter()
Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`actionProduced(Object obj)`	Action producer--get a window.
`protected String`	`getActionProducedMessage(long timeSpent, Object result)`	Overrides Waiter.getActionProducedMessage.
`protected ComponentChooser`	`getComponentChooser()`	Method can be used by a subclass to define chooser.
`String`	`getDescription()`	Returns description.
`protected String`	`getGoldenActionProducedMessage()`	Returns message to be printed int golden output when waiting has been successfully finished.
`protected String`	`getGoldenTimeoutExpiredMessage()`	Returns message to be printed int golden output when waiting timeout has been expired.
`protected String`	`getGoldenWaitingStartedMessage()`	Returns message to be printed int golden output before waiting start.
`protected Window`	`getOwner()`	Method can be used by a subclass to define window owner.
`protected String`	`getTimeoutExpiredMessage(long timeSpent)`	Overrides Waiter.getTimeoutExpiredMessage.
`Timeouts`	`getTimeouts()`	Return current timeouts.
`protected String`	`getWaitingStartedMessage()`	Returns message to be printed before waiting start.
`static Window`	`getWindow(Window owner, ComponentChooser cc)`	Searches for a window.
`static Window`	`getWindow(Window owner, ComponentChooser cc, int index)`	Searches for a window.
`static Window`	`getWindow(ComponentChooser cc)`	Searches for a window.
`static Window`	`getWindow(ComponentChooser cc, int index)`	Searches for a window.
`protected void`	`setComponentChooser(ComponentChooser ch)`	Method can be used by a subclass to define chooser.
`protected void`	`setOwner(Window owner)`	Method can be used by a subclass to define window owner.
`void`	`setTimeouts(Timeouts timeouts)`	Defines current timeouts.
`Window`	`waitWindow(Window o, ComponentChooser ch)`	Waits for a window to show.
`Window`	`waitWindow(Window o, ComponentChooser ch, int index)`	Waits for a window to show.
`Window`	`waitWindow(ComponentChooser ch)`	Waits for a window to show.
`Window`	`waitWindow(ComponentChooser ch, int index)`	Waits for a window to show.

Methods inherited from class org.netbeans.jemmy.Waiter
getOutput, setOutput, setTimeoutsToCloneOf, setWaitingTimeOrigin, timeFromStart, waitAction

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WindowWaiter
```
public WindowWaiter()
```
    Constructor.
- Method Detail
  - getWindow
```
public static Window getWindow(Window owner,
                               ComponentChooser cc,
                               int index)
```
    Searches for a window. The search proceeds among the currently showing windows for the index+1'th window that is both owned by the java.awt.Window owner and that meets the criteria defined and applied by the ComponentChooser parameter.
    
    Parameters:
    
    owner - The owner window of all the windows to be searched.
    
    cc - A component chooser used to define and apply the search criteria.
    
    index - The ordinal index of the window in the set of currently displayed windows with the proper window ownership and a suitable title. The first index is 0.
    
    Returns:
    
    a reference to the index+1'th window that is showing, has the proper window ownership, and that meets the search criteria. If there are fewer than index+1 windows, a null reference is returned.
  - getWindow
```
public static Window getWindow(Window owner,
                               ComponentChooser cc)
```
    Searches for a window. Search among the currently showing windows for the first that is both owned by the java.awt.Window owner and that meets the search criteria applied by the ComponentChooser parameter.
    
    Parameters:
    
    owner - The owner window of the windows to be searched.
    
    cc - A component chooser used to define and apply the search criteria.
    
    Returns:
    
    a reference to the first window that is showing, has a proper owner window, and that meets the search criteria. If no such window can be found, a null reference is returned.
  - getWindow
```
public static Window getWindow(ComponentChooser cc,
                               int index)
```
    Searches for a window. The search proceeds among the currently showing windows for the index+1'th window that meets the criteria defined and applied by the ComonentChooser parameter.
    
    Parameters:
    
    cc - A component chooser used to define and apply the search criteria.
    
    index - The ordinal index of the window in the set of currently displayed windows. The first index is 0.
    
    Returns:
    
    a reference to the index+1'th window that is showing and that meets the search criteria. If there are fewer than index+1 windows, a null reference is returned.
  - getWindow
```
public static Window getWindow(ComponentChooser cc)
```
    Searches for a window. Search among the currently showing windows for one that meets the search criteria applied by the ComponentChooser parameter.
    
    Parameters:
    
    cc - A component chooser used to define and apply the search criteria.
    
    Returns:
    
    a reference to the first window that is showing and that meets the search criteria. If no such window can be found, a null reference is returned.
  - setTimeouts
```
public void setTimeouts(Timeouts timeouts)
```
    Defines current timeouts.
    
    Specified by:
    
    setTimeouts in interface Timeoutable
    
    Overrides:
    
    setTimeouts in class Waiter
    
    Parameters:
    
    timeouts - A collection of timeout assignments.
    
    See Also:
    
    Timeoutable, Timeouts, getTimeouts()
  - getTimeouts
```
public Timeouts getTimeouts()
```
    Return current timeouts.
    
    Specified by:
    
    getTimeouts in interface Timeoutable
    
    Overrides:
    
    getTimeouts in class Waiter
    
    Returns:
    
    the collection of current timeout assignments.
    
    See Also:
    
    Timeoutable, Timeouts, setTimeouts(org.netbeans.jemmy.Timeouts)
  - actionProduced
```
public Object actionProduced(Object obj)
```
    Action producer--get a window. Get a window. The search uses constraints on window ownership, ordinal index, and search criteria defined by an instance of org.netbeans.jemmy.ComponentChooser.
    
    Specified by:
    
    actionProduced in interface Waitable
    
    Overrides:
    
    actionProduced in class Waiter
    
    Parameters:
    
    obj - Not used.
    
    Returns:
    
    the window waited upon. If a window cannot be found then a null reference is returned.
    
    See Also:
    
    Action
  - waitWindow
```
public Window waitWindow(ComponentChooser ch,
                         int index)
                  throws InterruptedException
```
    Waits for a window to show. Wait for the index+1'th window that meets the criteria defined and applied by the ComonentChooser parameter to show up.
    
    Parameters:
    
    ch - A component chooser used to define and apply the search criteria.
    
    index - The ordinal index of the window in the set of currently displayed windows. The first index is 0.
    
    Returns:
    
    a reference to the index+1'th window that shows and that meets the search criteria. If fewer than index+1 windows show up in the allotted time period then a null reference is returned.
    
    Throws:
    
    TimeoutExpiredException
    
    InterruptedException
    
    See Also:
    
    actionProduced(Object)
  - waitWindow
```
public Window waitWindow(ComponentChooser ch)
                  throws InterruptedException
```
    Waits for a window to show. Wait for a window that meets the search criteria applied by the ComponentChooser parameter to show up.
    
    Parameters:
    
    ch - A component chooser used to define and apply the search criteria.
    
    Returns:
    
    a reference to the first window that shows and that meets the search criteria. If no such window can be found within the time period allotted, a null reference is returned.
    
    Throws:
    
    TimeoutExpiredException
    
    InterruptedException
    
    See Also:
    
    actionProduced(Object)
  - waitWindow
```
public Window waitWindow(Window o,
                         ComponentChooser ch,
                         int index)
                  throws InterruptedException
```
    Waits for a window to show. Wait for the index+1'th window to show that is both owned by the java.awt.Window o and that meets the criteria defined and applied by the ComponentChooser parameter.
    
    Parameters:
    
    o - The owner window of all the windows to be searched.
    
    ch - A component chooser used to define and apply the search criteria.
    
    index - The ordinal index of the window in the set of currently displayed windows with the proper window ownership and a suitable title. The first index is 0.
    
    Returns:
    
    a reference to the index+1'th window to show that has the proper window ownership, and that meets the search criteria. If there are fewer than index+1 windows, a null reference is returned.
    
    Throws:
    
    TimeoutExpiredException
    
    InterruptedException
    
    See Also:
    
    actionProduced(Object)
  - waitWindow
```
public Window waitWindow(Window o,
                         ComponentChooser ch)
                  throws InterruptedException
```
    Waits for a window to show. Wait for the first window to show that is both owned by the java.awt.Window o and that meets the criteria defined and applied by the ComponentChooser parameter.
    
    Parameters:
    
    o - The owner window of all the windows to be searched.
    
    ch - A component chooser used to define and apply the search criteria.
    
    Returns:
    
    a reference to the first window to show that has the proper window ownership, and that meets the search criteria. If there is no such window, a null reference is returned.
    
    Throws:
    
    TimeoutExpiredException
    
    InterruptedException
    
    See Also:
    
    actionProduced(Object)
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Waitable
    
    Returns description.
    
    Specified by:
    
    getDescription in interface Waitable
    
    Overrides:
    
    getDescription in class Waiter
    
    Returns:
    
    a description of the wait criteria.
    
    See Also:
    
    Waitable
  - setComponentChooser
```
protected void setComponentChooser(ComponentChooser ch)
```
    Method can be used by a subclass to define chooser.
    
    Parameters:
    
    ch - a chooser specifying searching criteria.
    
    See Also:
    
    getComponentChooser()
  - getComponentChooser
```
protected ComponentChooser getComponentChooser()
```
    Method can be used by a subclass to define chooser.
    
    Returns:
    
    a chooser specifying searching criteria.
    
    See Also:
    
    setComponentChooser(org.netbeans.jemmy.ComponentChooser)
  - setOwner
```
protected void setOwner(Window owner)
```
    Method can be used by a subclass to define window owner.
    
    Parameters:
    
    owner - Window-owner of the set of windows.
    
    See Also:
    
    getOwner()
  - getOwner
```
protected Window getOwner()
```
    Method can be used by a subclass to define window owner.
    
    Returns:
    
    Window-owner of the set of windows.
    
    See Also:
    
    setOwner(java.awt.Window)
  - getWaitingStartedMessage
```
protected String getWaitingStartedMessage()
```
    Description copied from class: Waiter
    
    Returns message to be printed before waiting start.
    
    Overrides:
    
    getWaitingStartedMessage in class Waiter
    
    Returns:
    
    a message.
    
    See Also:
    
    Waiter.getWaitingStartedMessage()
  - getTimeoutExpiredMessage
```
protected String getTimeoutExpiredMessage(long timeSpent)
```
    Overrides Waiter.getTimeoutExpiredMessage.
    
    Overrides:
    
    getTimeoutExpiredMessage in class Waiter
    
    Parameters:
    
    timeSpent - time from waiting start (milliseconds)
    
    Returns:
    
    a message.
    
    See Also:
    
    Waiter.getTimeoutExpiredMessage(long)
  - getActionProducedMessage
```
protected String getActionProducedMessage(long timeSpent,
                                          Object result)
```
    Overrides Waiter.getActionProducedMessage.
    
    Overrides:
    
    getActionProducedMessage in class Waiter
    
    Parameters:
    
    timeSpent - time from waiting start (milliseconds)
    
    result - result of Waitable.actionproduced method.
    
    Returns:
    
    a message.
    
    See Also:
    
    Waiter.getActionProducedMessage(long, Object)
  - getGoldenWaitingStartedMessage
```
protected String getGoldenWaitingStartedMessage()
```
    Description copied from class: Waiter
    
    Returns message to be printed int golden output before waiting start.
    
    Overrides:
    
    getGoldenWaitingStartedMessage in class Waiter
    
    Returns:
    
    a message.
    
    See Also:
    
    Waiter.getGoldenWaitingStartedMessage()
  - getGoldenTimeoutExpiredMessage
```
protected String getGoldenTimeoutExpiredMessage()
```
    Description copied from class: Waiter
    
    Returns message to be printed int golden output when waiting timeout has been expired.
    
    Overrides:
    
    getGoldenTimeoutExpiredMessage in class Waiter
    
    Returns:
    
    a message.
    
    See Also:
    
    Waiter.getGoldenTimeoutExpiredMessage()
  - getGoldenActionProducedMessage
```
protected String getGoldenActionProducedMessage()
```
    Description copied from class: Waiter
    
    Returns message to be printed int golden output when waiting has been successfully finished.
    
    Overrides:
    
    getGoldenActionProducedMessage in class Waiter
    
    Returns:
    
    a message.
    
    See Also:
    
    Waiter.getGoldenActionProducedMessage()

Class WindowWaiter

Constructor Summary

Method Summary

Methods inherited from class org.netbeans.jemmy.Waiter

Methods inherited from class java.lang.Object

Constructor Detail

WindowWaiter

Method Detail

getWindow

getWindow

getWindow

getWindow

setTimeouts

getTimeouts

actionProduced

waitWindow

waitWindow

waitWindow

waitWindow

getDescription

setComponentChooser

getComponentChooser

setOwner

getOwner

getWaitingStartedMessage

getTimeoutExpiredMessage

getActionProducedMessage

getGoldenWaitingStartedMessage

getGoldenTimeoutExpiredMessage

getGoldenActionProducedMessage