public class FrameWaiter extends WindowWaiter implements Timeoutable, Outputable
Timeouts
Constructor and Description |
---|
FrameWaiter()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
getActionProducedMessage(long timeSpent,
java.lang.Object result)
Overrides WindowWaiter.getActionProducedMessage.
|
static java.awt.Frame |
getFrame(ComponentChooser cc)
Searches for a Frame.
|
static java.awt.Frame |
getFrame(ComponentChooser cc,
int index)
Searches for a Frame.
|
static java.awt.Frame |
getFrame(java.lang.String title,
boolean ce,
boolean cc)
Searches for a Frame by title.
|
static java.awt.Frame |
getFrame(java.lang.String title,
boolean ce,
boolean cc,
int index)
Searches for a Frame by title.
|
protected java.lang.String |
getGoldenActionProducedMessage()
Returns message to be printed int golden output when waiting has been successfully finished.
|
protected java.lang.String |
getGoldenTimeoutExpiredMessage()
Returns message to be printed int golden output when waiting timeout has been expired.
|
protected java.lang.String |
getGoldenWaitingStartedMessage()
Returns message to be printed int golden output before waiting start.
|
TestOut |
getOutput()
Returns print output streams or writers.
|
protected java.lang.String |
getTimeoutExpiredMessage(long timeSpent)
Overrides WindowWaiter.getTimeoutExpiredMessage.
|
Timeouts |
getTimeouts()
Return current timeouts.
|
protected java.lang.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.
|
java.awt.Frame |
waitFrame(ComponentChooser ch)
Waits for a Frame to show.
|
java.awt.Frame |
waitFrame(ComponentChooser ch,
int index)
Waits for a Frame to show.
|
java.awt.Frame |
waitFrame(java.lang.String title,
boolean compareExactly,
boolean compareCaseSensitive)
Waits for a Frame to show.
|
java.awt.Frame |
waitFrame(java.lang.String title,
boolean compareExactly,
boolean compareCaseSensitive,
int index)
Waits for a Frame to show.
|
actionProduced, getComponentChooser, getDescription, getOwner, getWindow, getWindow, getWindow, getWindow, setComponentChooser, setOwner, waitWindow, waitWindow, waitWindow, waitWindow
timeFromStart, waitAction
public static java.awt.Frame getFrame(ComponentChooser cc)
ComponentChooser
parameter.cc
- A component chooser used to define and apply the search criteria.null
reference is returned.public static java.awt.Frame getFrame(ComponentChooser cc, int index)
index+1
'th Frame that meets the criteria defined and
applied by the ComonentChooser
parameter.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.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.public static java.awt.Frame getFrame(java.lang.String title, boolean ce, boolean cc)
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.null
reference is returned.public static java.awt.Frame getFrame(java.lang.String title, boolean ce, boolean cc, int index)
index+1
'th Frame among the currently
showing Frames that possess a suitable title.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.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.public void setTimeouts(Timeouts timeouts)
setTimeouts
in interface Timeoutable
setTimeouts
in class WindowWaiter
timeouts
- A collection of timeout assignments.Timeoutable
,
Timeouts
,
getTimeouts()
public Timeouts getTimeouts()
getTimeouts
in interface Timeoutable
getTimeouts
in class WindowWaiter
Timeoutable
,
Timeouts
,
setTimeouts(org.netbeans.jemmy.Timeouts)
public void setOutput(TestOut output)
setOutput
in interface Outputable
setOutput
in class Waiter
output
- Identify the streams or writers used for print output.Outputable
,
TestOut
,
getOutput()
public TestOut getOutput()
getOutput
in interface Outputable
getOutput
in class Waiter
Outputable
,
TestOut
,
setOutput(org.netbeans.jemmy.TestOut)
public java.awt.Frame waitFrame(ComponentChooser ch, int index) throws java.lang.InterruptedException
index+1
'th Frame that meets the criteria
defined and applied by the ComonentChooser
parameter to
show up.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.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.TimeoutExpiredException
java.lang.InterruptedException
WindowWaiter.actionProduced(Object)
public java.awt.Frame waitFrame(ComponentChooser ch) throws java.lang.InterruptedException
ComponentChooser
parameter to show up.ch
- A component chooser used to define and apply the search criteria.null
reference is returned.TimeoutExpiredException
java.lang.InterruptedException
WindowWaiter.actionProduced(Object)
public java.awt.Frame waitFrame(java.lang.String title, boolean compareExactly, boolean compareCaseSensitive, int index) throws java.lang.InterruptedException
index+1
'th Frame to show with a suitable title.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.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.TimeoutExpiredException
java.lang.InterruptedException
WindowWaiter.actionProduced(Object)
public java.awt.Frame waitFrame(java.lang.String title, boolean compareExactly, boolean compareCaseSensitive) throws java.lang.InterruptedException
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.null
reference is returned.TimeoutExpiredException
java.lang.InterruptedException
WindowWaiter.actionProduced(Object)
protected java.lang.String getWaitingStartedMessage()
Waiter
getWaitingStartedMessage
in class WindowWaiter
Waiter.getWaitingStartedMessage()
protected java.lang.String getTimeoutExpiredMessage(long timeSpent)
getTimeoutExpiredMessage
in class WindowWaiter
timeSpent
- Time spent for waitingWaiter.getTimeoutExpiredMessage(long)
protected java.lang.String getActionProducedMessage(long timeSpent, java.lang.Object result)
getActionProducedMessage
in class WindowWaiter
timeSpent
- Time spent for waiting.result
- A message string.Waiter.getActionProducedMessage(long, Object)
protected java.lang.String getGoldenWaitingStartedMessage()
Waiter
getGoldenWaitingStartedMessage
in class WindowWaiter
Waiter.getGoldenWaitingStartedMessage()
protected java.lang.String getGoldenTimeoutExpiredMessage()
Waiter
getGoldenTimeoutExpiredMessage
in class WindowWaiter
Waiter.getGoldenTimeoutExpiredMessage()
protected java.lang.String getGoldenActionProducedMessage()
Waiter
getGoldenActionProducedMessage
in class WindowWaiter
Waiter.getGoldenActionProducedMessage()