FrameWaiter

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

All Implemented Interfaces:

Outputable, Timeoutable, Waitable
```
public class FrameWaiter
extends WindowWaiter
implements Timeoutable, Outputable
```
Contains methods to search and wait Frame. A FrameWaiter is a utility class used to look or wait for Frames. It contains methods to search for a Frame among the currently showing Frames as well as methods that wait for a Frame to show within an allotted time period.

Timeouts used:
FrameWaiter.WaitFrameTimeout - time to wait frame displayed.
FrameWaiter.AfterFrameTimeout - time to sleep after frame has been displayed.

Author:

Alexandre Iline (alexandre.iline@sun.com)

See Also:

Timeouts

Constructor Summary

Constructors
Constructor and Description

FrameWaiter()
Constructor.

Constructors
Constructor and Description
`FrameWaiter()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`getActionProducedMessage(long timeSpent, Object result)` Overrides WindowWaiter.getActionProducedMessage.
`static Frame`	`getFrame(ComponentChooser cc)` Searches for a Frame.
`static Frame`	`getFrame(ComponentChooser cc, int index)` Searches for a Frame.
`static Frame`	`getFrame(String title, boolean ce, boolean cc)` Searches for a Frame by title.
`static Frame`	`getFrame(String title, boolean ce, boolean cc, int index)` Searches for a Frame by title.
`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.
`TestOut`	`getOutput()` Returns print output streams or writers.
`protected String`	`getTimeoutExpiredMessage(long timeSpent)` Overrides WindowWaiter.getTimeoutExpiredMessage.
`Timeouts`	`getTimeouts()` Return current timeouts.
`protected String`	`getWaitingStartedMessage()` Returns message to be printed before waiting start.
`void`	`setOutput(TestOut output)` Defines print output streams or writers.
`void`	`setTimeouts(Timeouts timeouts)` Defines current timeouts.
`Frame`	`waitFrame(ComponentChooser ch)` Waits for a Frame to show.
`Frame`	`waitFrame(ComponentChooser ch, int index)` Waits for a Frame to show.
`Frame`	`waitFrame(String title, boolean compareExactly, boolean compareCaseSensitive)` Waits for a Frame to show.
`Frame`	`waitFrame(String title, boolean compareExactly, boolean compareCaseSensitive, int index)` Waits for a Frame to show.

Methods inherited from class org.netbeans.jemmy.WindowWaiter
actionProduced, getComponentChooser, getDescription, getOwner, getWindow, getWindow, getWindow, getWindow, setComponentChooser, setOwner, waitWindow, waitWindow, waitWindow, waitWindow

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

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

- Constructor Detail
  - FrameWaiter
```
public FrameWaiter()
```
    Constructor.
- Method Detail
  - getFrame
```
public static Frame getFrame(ComponentChooser cc)
```
    Searches for a Frame. Search among the currently showing Frames 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 Frame that is showing and that meets the search criteria. If no such Frame can be found, a null reference is returned.
  - getFrame
```
public static Frame getFrame(ComponentChooser cc,
                             int index)
```
    Searches for a Frame. The search proceeds among the currently showing Frames for the index+1'th Frame 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 Frame in the set of currently displayed Frames. The first index is 0.
    
    Returns:
    
    a reference to the index+1'th Frame that is showing and that meets the search criteria. If there are fewer than index+1 Frames, a null reference is returned.
  - getFrame
```
public static Frame getFrame(String title,
                             boolean ce,
                             boolean cc)
```
    Searches for a Frame by title. The search proceeds among the currently showing Frames for the first with a suitable title.
    
    Parameters:
    
    title - Frame title or subtitle.
    
    ce - If true and the search is case sensitive, then a match occurs when the title argument is a substring of a Frame title. If false and the search is case sensitive, then the title argument and the Frame title must be the same. If true and the search is case insensitive, then a match occurs when the title argument is a substring of the Frame title after changing both to upper case. If false and the search is case insensitive, then a match occurs when the title argument is a substring of the Frame title after changing both to upper case.
    
    cc - If true the search is case sensitive; otherwise, the search is case insensitive.
    
    Returns:
    
    a reference to the first Frame that is showing and that has a suitable title. If no such Frame can be found, a null reference is returned.
  - getFrame
```
public static Frame getFrame(String title,
                             boolean ce,
                             boolean cc,
                             int index)
```
    Searches for a Frame by title. The search is for the index+1'th Frame among the currently showing Frames that possess a suitable title.
    
    Parameters:
    
    title - Frame title or subtitle.
    
    ce - If true and the search is case sensitive, then a match occurs when the title argument is a substring of a Frame title. If false and the search is case sensitive, then the title argument and the Frame title must be the same. If true and the search is case insensitive, then a match occurs when the title argument is a substring of the Frame title after changing both to upper case. If false and the search is case insensitive, then a match occurs when the title argument is a substring of the Frame title after changing both to upper case.
    
    cc - If true the search is case sensitive; otherwise, the search is case insensitive.
    
    index - The ordinal index of the Frame in the set of currently displayed Frames. The first index is 0.
    
    Returns:
    
    a reference to the index+1'th Frame that is showing and that has a suitable title. If there are fewer than index+1 Frames, a null reference is returned.
  - setTimeouts
```
public void setTimeouts(Timeouts timeouts)
```
    Defines current timeouts.
    
    Specified by:
    
    setTimeouts in interface Timeoutable
    
    Overrides:
    
    setTimeouts in class WindowWaiter
    
    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 WindowWaiter
    
    Returns:
    
    the collection of current timeout assignments.
    
    See Also:
    
    Timeoutable, Timeouts, setTimeouts(org.netbeans.jemmy.Timeouts)
  - setOutput
```
public void setOutput(TestOut output)
```
    Defines print output streams or writers.
    
    Specified by:
    
    setOutput in interface Outputable
    
    Overrides:
    
    setOutput in class Waiter
    
    Parameters:
    
    output - Identify the streams or writers used for print output.
    
    See Also:
    
    Outputable, TestOut, getOutput()
  - getOutput
```
public TestOut getOutput()
```
    Returns print output streams or writers.
    
    Specified by:
    
    getOutput in interface Outputable
    
    Overrides:
    
    getOutput in class Waiter
    
    Returns:
    
    an object that contains references to objects for printing to output and err streams.
    
    See Also:
    
    Outputable, TestOut, setOutput(org.netbeans.jemmy.TestOut)
  - waitFrame
```
public Frame waitFrame(ComponentChooser ch,
                       int index)
                throws InterruptedException
```
    Waits for a Frame to show. Wait for the index+1'th Frame 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 Frame in the set of currently displayed Frames. The first index is 0.
    
    Returns:
    
    a reference to the index+1'th Frame that shows and that meets the search criteria. If fewer than index+1 Frames show up in the allotted time period then a null reference is returned.
    
    Throws:
    
    TimeoutExpiredException
    
    InterruptedException
    
    See Also:
    
    WindowWaiter.actionProduced(Object)
  - waitFrame
```
public Frame waitFrame(ComponentChooser ch)
                throws InterruptedException
```
    Waits for a Frame to show. Wait for a Frame 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 Frame that shows and that meets the search criteria. If no such Frame can be found within the time period allotted, a null reference is returned.
    
    Throws:
    
    TimeoutExpiredException
    
    InterruptedException
    
    See Also:
    
    WindowWaiter.actionProduced(Object)
  - waitFrame
```
public Frame waitFrame(String title,
                       boolean compareExactly,
                       boolean compareCaseSensitive,
                       int index)
                throws InterruptedException
```
    Waits for a Frame to show. Wait for the index+1'th Frame to show with a suitable title.
    
    Parameters:
    
    title - Frame title or subtitle.
    
    compareExactly - If true and the search is case sensitive, then a match occurs when the title argument is a substring of a Frame title. If false and the search is case sensitive, then the title argument and the Frame title must be the same. If true and the search is case insensitive, then a match occurs when the title argument is a substring of the Frame title after changing both to upper case. If false and the search is case insensitive, then a match occurs when the title argument is a substring of the Frame title after changing both to upper case.
    
    compareCaseSensitive - If true the search is case sensitive; otherwise, the search is case insensitive.
    
    index - The ordinal index of the Frame in the set of currently displayed Frames with the proper window ownership and a suitable title. The first index is 0.
    
    Returns:
    
    a reference to the index+1'th Frame to show and that has a suitable title. If no such Frame can be found within the time period allotted, a null reference is returned.
    
    Throws:
    
    TimeoutExpiredException
    
    InterruptedException
    
    See Also:
    
    WindowWaiter.actionProduced(Object)
  - waitFrame
```
public Frame waitFrame(String title,
                       boolean compareExactly,
                       boolean compareCaseSensitive)
                throws InterruptedException
```
    Waits for a Frame to show. Wait for the first Frame to show with a suitable title.
    
    Parameters:
    
    title - Frame title or subtitle.
    
    compareExactly - If true and the search is case sensitive, then a match occurs when the title argument is a substring of a Frame title. If false and the search is case sensitive, then the title argument and the Frame title must be the same. If true and the search is case insensitive, then a match occurs when the title argument is a substring of the Frame title after changing both to upper case. If false and the search is case insensitive, then a match occurs when the title argument is a substring of the Frame title after changing both to upper case.
    
    compareCaseSensitive - If true the search is case sensitive; otherwise, the search is case insensitive.
    
    Returns:
    
    a reference to the first Frame to show and that has a suitable title. If no such Frame can be found within the time period allotted, a null reference is returned.
    
    Throws:
    
    TimeoutExpiredException
    
    InterruptedException
    
    See Also:
    
    WindowWaiter.actionProduced(Object)
  - getWaitingStartedMessage
```
protected String getWaitingStartedMessage()
```
    Description copied from class: Waiter
    
    Returns message to be printed before waiting start.
    
    Overrides:
    
    getWaitingStartedMessage in class WindowWaiter
    
    Returns:
    
    a message.
    
    See Also:
    
    Waiter.getWaitingStartedMessage()
  - getTimeoutExpiredMessage
```
protected String getTimeoutExpiredMessage(long timeSpent)
```
    Overrides WindowWaiter.getTimeoutExpiredMessage. Returns the timeout expired message value.
    
    Overrides:
    
    getTimeoutExpiredMessage in class WindowWaiter
    
    Parameters:
    
    timeSpent - Time spent for waiting
    
    Returns:
    
    a message tring
    
    See Also:
    
    Waiter.getTimeoutExpiredMessage(long)
  - getActionProducedMessage
```
protected String getActionProducedMessage(long timeSpent,
                                          Object result)
```
    Overrides WindowWaiter.getActionProducedMessage. Returns the action produced message value.
    
    Overrides:
    
    getActionProducedMessage in class WindowWaiter
    
    Parameters:
    
    timeSpent - Time spent for waiting.
    
    result - A message string.
    
    Returns:
    
    a message tring
    
    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 WindowWaiter
    
    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 WindowWaiter
    
    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 WindowWaiter
    
    Returns:
    
    a message.
    
    See Also:
    
    Waiter.getGoldenActionProducedMessage()

Class FrameWaiter

Constructor Summary

Method Summary

Methods inherited from class org.netbeans.jemmy.WindowWaiter

Methods inherited from class org.netbeans.jemmy.Waiter

Methods inherited from class java.lang.Object

Constructor Detail

FrameWaiter

Method Detail

getFrame

getFrame

getFrame

getFrame

setTimeouts

getTimeouts

setOutput

getOutput

waitFrame

waitFrame

waitFrame

waitFrame

getWaitingStartedMessage

getTimeoutExpiredMessage

getActionProducedMessage

getGoldenWaitingStartedMessage

getGoldenTimeoutExpiredMessage

getGoldenActionProducedMessage