|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.team.fvt.tests.web.WebPage
public abstract class WebPage
The abstract class for any web page connected to a WebBrowser
.
A web page is created using a location
which is the initial url sent to
the browser to load the page. It may slightly differ from the browser current
url after it has been loaded (see getUrl()
.
It also stores the configuration used while running the test in order to access any necessary information from it (e.g. timeouts).
Finally, the web page is also associated with a user
as its content
might slightly or completely differ depending of it. This user let also the page
know whether a login operation when a new one is connected to it.
This class provides the following basic functionalities:
getPage(String)
: Get from the cache the page instance for the
given location.
Constructor Summary | |
---|---|
WebPage(java.lang.String url,
Config config,
User user)
|
Method Summary | ||
---|---|---|
void |
changeUser(User newUser)
Change the user on the current page. |
|
|
checkHoverTitle(WebBrowserElement linkElement,
java.lang.Class<P> hoverClass)
Check the hover title of the given link element. |
|
|
checkRichHover(WebBrowserElement linkElement,
java.lang.Class<RH> richHoverClass,
java.lang.String... data)
Check the rich hover of the given link element. |
|
WebPage |
get()
Get the page content. |
|
WebBrowser |
getBrowser()
Return the browser associated with the current page. |
|
Config |
getConfig()
Return the configuration associated with the current page. |
|
java.lang.String |
getLocation()
Return the page location used when creating it. |
|
static WebPage |
getPage(java.lang.String location)
Get from the cache the page instance for the given location. |
|
User |
getUser()
Return the user used when the page was loaded. |
|
WebPage |
goBack()
Move back a single "item" in the browser's history. |
|
boolean |
logout(User newUser)
Logout the page from current user to new user. |
|
static WebPage |
openPage(java.lang.String location)
|
|
static
|
openPage(java.lang.String location,
Config config,
User user,
java.lang.Class<P> pageClass,
java.lang.String... data)
Retrieve the existing page for the given location. |
|
void |
refresh()
Refresh the page content using WebBrowser.refresh() and wait for
the page to be loaded (see waitForLoadingPageEnd() ). |
|
|
richHoverOverLink(WebBrowserElement linkElement,
java.lang.Class<RH> richHoverClass,
java.lang.String... additionalData)
Perform a mouse hovering over the given link element. |
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public WebPage(java.lang.String url, Config config, User user)
Method Detail |
---|
public static WebPage getPage(java.lang.String location)
location
- The page location
null
if this page hasn't been created yet.public static WebPage openPage(java.lang.String location)
public static <P extends WebPage> P openPage(java.lang.String location, Config config, User user, java.lang.Class<P> pageClass, java.lang.String... data)
location
- The url of the pageconfig
- The config to use for the requested pageuser
- The user to use on the requested pagepageClass
- The class associated with the page to opendata
- Additional CLM information to be stored in the page
public void changeUser(User newUser)
newUser
- The new user to loginpublic <P extends WebHover<? extends WebPage>> P checkHoverTitle(WebBrowserElement linkElement, java.lang.Class<P> hoverClass)
This check opens the hover by positioning the mouse pointer over the given link element and checks whether its title matches the given text.
P
- The expected class for the hoverlinkElement
- The link on which to hoverhoverClass
- The expected class for the hover
WebBrowserElement
ScenarioFailedError
- in following cases:
shortTimeout()
(typically
when the hover is still empty when the timeout is reached)public <RH extends WebRichHover<? extends WebPage>> RH checkRichHover(WebBrowserElement linkElement, java.lang.Class<RH> richHoverClass, java.lang.String... data)
This check opens the rich hover by positioning the mouse pointer over the given link element and perform checks on its content (typically the title).
RH
- The expected class for the hoverlinkElement
- The link on which to hoverrichHoverClass
- The expected class for the hover
WebBrowserElement
ScenarioFailedError
- in following cases:
shortTimeout()
(typically
when the hover is still empty when the timeout is reached)public final WebPage get()
public WebBrowser getBrowser()
WebBrowser
public Config getConfig()
Config
public java.lang.String getLocation()
public User getUser()
user
.public WebPage goBack()
WebDriver.Navigation#back()
public boolean logout(User newUser)
newUser
- public void refresh()
WebBrowser.refresh()
and wait for
the page to be loaded (see waitForLoadingPageEnd()
).
If subclass overrides this method, it's strongly recommended to call the super
implementation in order to implicitly wait for the end of the page load, but also
to set the refreshed
flag...
public <RH extends WebRichHover<? extends WebPage>> RH richHoverOverLink(WebBrowserElement linkElement, java.lang.Class<RH> richHoverClass, java.lang.String... additionalData)
RH
- The rich hover specialized classlinkElement
- The web element on which to hoverrichHoverClass
- The rich hover specialized classadditionalData
- Additional data to check in the rich hover
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |