|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.netbeans.jemmy.Waiter
org.netbeans.jemmy.WindowWaiter
public class WindowWaiter
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
Timeouts
Constructor Summary | |
---|---|
WindowWaiter()
Constructor. |
Method Summary | |
---|---|
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(ComponentChooser cc)
Searches for a window. |
static Window |
getWindow(ComponentChooser cc,
int index)
Searches for a window. |
static Window |
getWindow(Window owner,
ComponentChooser cc)
Searches for a window. |
static Window |
getWindow(Window owner,
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(ComponentChooser ch)
Waits for a window to show. |
Window |
waitWindow(ComponentChooser ch,
int index)
Waits for a window to show. |
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. |
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 |
---|
public WindowWaiter()
Method Detail |
---|
public static Window getWindow(Window owner, ComponentChooser cc, int index)
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.
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.
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.public static Window getWindow(Window owner, ComponentChooser cc)
java.awt.Window
owner
and that
meets the search criteria applied by the ComponentChooser
parameter.
owner
- The owner window of the windows to be searched.cc
- A component chooser used to define and apply the search criteria.
null
reference is returned.public static Window getWindow(ComponentChooser cc, int index)
index+1
'th window 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 window in the set of currently displayed
windows. The first index is 0.
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.public static Window getWindow(ComponentChooser cc)
ComponentChooser
parameter.
cc
- A component chooser used to define and apply the search criteria.
null
reference is returned.public void setTimeouts(Timeouts timeouts)
setTimeouts
in interface Timeoutable
setTimeouts
in class Waiter
timeouts
- A collection of timeout assignments.Timeoutable
,
Timeouts
,
getTimeouts()
public Timeouts getTimeouts()
getTimeouts
in interface Timeoutable
getTimeouts
in class Waiter
Timeoutable
,
Timeouts
,
setTimeouts(org.netbeans.jemmy.Timeouts)
public Object actionProduced(Object obj)
org.netbeans.jemmy.ComponentChooser
.
actionProduced
in interface Waitable
actionProduced
in class Waiter
obj
- Not used.
null
reference is returned.Action
public Window waitWindow(ComponentChooser ch, int index) throws InterruptedException
index+1
'th window 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 window in the set of currently displayed
windows. The first index is 0.
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.
TimeoutExpiredException
InterruptedException
actionProduced(Object)
public Window waitWindow(ComponentChooser ch) throws InterruptedException
ComponentChooser
parameter to show up.
ch
- A component chooser used to define and apply the search criteria.
null
reference is returned.
TimeoutExpiredException
InterruptedException
actionProduced(Object)
public Window waitWindow(Window o, ComponentChooser ch, int index) throws InterruptedException
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.
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.
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.
TimeoutExpiredException
InterruptedException
actionProduced(Object)
public Window waitWindow(Window o, ComponentChooser ch) throws InterruptedException
java.awt.Window
o
and that meets the
criteria defined and applied by the ComponentChooser
parameter.
o
- The owner window of all the windows to be searched.ch
- A component chooser used to define and apply the search criteria.
null
reference is returned.
TimeoutExpiredException
InterruptedException
actionProduced(Object)
public String getDescription()
Waitable
getDescription
in interface Waitable
getDescription
in class Waiter
Waitable
protected void setComponentChooser(ComponentChooser ch)
ch
- a chooser specifying searching criteria.getComponentChooser()
protected ComponentChooser getComponentChooser()
setComponentChooser(org.netbeans.jemmy.ComponentChooser)
protected void setOwner(Window owner)
owner
- Window-owner of the set of windows.getOwner()
protected Window getOwner()
setOwner(java.awt.Window)
protected String getWaitingStartedMessage()
Waiter
getWaitingStartedMessage
in class Waiter
Waiter.getWaitingStartedMessage()
protected String getTimeoutExpiredMessage(long timeSpent)
getTimeoutExpiredMessage
in class Waiter
timeSpent
- time from waiting start (milliseconds)
Waiter.getTimeoutExpiredMessage(long)
protected String getActionProducedMessage(long timeSpent, Object result)
getActionProducedMessage
in class Waiter
timeSpent
- time from waiting start (milliseconds)result
- result of Waitable.actionproduced method.
Waiter.getActionProducedMessage(long, Object)
protected String getGoldenWaitingStartedMessage()
Waiter
getGoldenWaitingStartedMessage
in class Waiter
Waiter.getGoldenWaitingStartedMessage()
protected String getGoldenTimeoutExpiredMessage()
Waiter
getGoldenTimeoutExpiredMessage
in class Waiter
Waiter.getGoldenTimeoutExpiredMessage()
protected String getGoldenActionProducedMessage()
Waiter
getGoldenActionProducedMessage
in class Waiter
Waiter.getGoldenActionProducedMessage()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |