Class WindowWaiter

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:

  • Constructor Details

    • WindowWaiter

      public WindowWaiter()
      Constructor.

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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

      protected ComponentChooser getComponentChooser()
      Method can be used by a subclass to define chooser.
      Returns:
      a chooser specifying searching criteria.
      See Also:

    • 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

      protected Window getOwner()
      Method can be used by a subclass to define window owner.
      Returns:
      Window-owner of the set of windows.
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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: