com.github.mkolisnyk.sirius.client.ui

Class Page

java.lang.Object

com.github.mkolisnyk.sirius.client.ui.Page

Direct Known Subclasses:

AlertPage

public class Page
extends java.lang.Object

Common class for all page objects. Any abstraction which represents the application under test page should be extended from this class.

Author:

Mykola Kolisnyk

Constructor Summary

Constructors

Constructor and Description
Page(org.openqa.selenium.WebDriver driverValue) Default constructor which binds the WebDriver instance to the Page abstractions.

Method Summary

Modifier and Type	Method and Description
boolean	allOf(Control[] elements, Operation<java.lang.Boolean,Control> predicate) Checks if all elements passed as the parameter have the state specified by predicate.
boolean	anyOf(Control[] elements, Operation<java.lang.Boolean,Control> predicate) Checks if any of elements passed as the parameter has the state specified by predicate.
byte[]	captureScreenShot() Captures the screenshot of current page.
java.io.File	captureScreenShot(java.lang.String destination) Captures the screenshot of current page and stores it in the file.
Control	field(java.lang.String name) Gets the current page class control with logical name specified.
<T extends Control> T	field(java.lang.String name, java.lang.Class<T> controlType) Gets the current page class control with logical name specified.
static Page	forName(java.lang.String name) Retrieves page object by it's logical name specified as the value of Alias annotation.
static Page	forName(java.lang.String name, java.lang.String pagePackage) Retrieves page object by it's logical name specified as the value of Alias annotation.
static Page	getCurrent() Gets the current page for current thread instance.
static Page	getCurrentFromList(java.lang.Class<? extends Page>[] pageClasses, int tries) Checks multiple page classes in order to identify which of the classes proposed fit the current page.
static Page	getCurrentFromList(java.lang.Class<? extends Page>[] pageClasses, int tries, boolean useCache) Checks multiple page classes in order to identify which of the classes proposed fit the current page.
static java.lang.String	getDefaultPagesPackage() Returns package name which is used as the root package for all page classes in the entire solution.
org.openqa.selenium.WebDriver	getDriver() Gets the actual WebDriver object if some WebDriver API is needed directly.
static Control	getFirstAvailableControlFromList(Control[] controls, int tries) Goes through the list of proposed controls and returns the first one which appears.
Control	getScrollable() Returns element which is available for scrolling.
java.lang.String	getSource() Gets the page source code.
Control	getTextControl(java.lang.String message) Dynamically generates control object which corresponds to the element containing text specified by the parameter.
static int	getTimeout() Returns the timeout value which is currently set.
void	hideKeyboard() Forcibly hides the virtual keyboard.
boolean	is(Operation<java.lang.Boolean,Page> predicate) Checks some state of page depending on predicate specified.
boolean	isTextPresent(java.lang.String text) Checks if some text is available on current page.
Page	navigate() Performs actions to navigate to current page.
boolean	scrollTo(boolean up) Swipes screen to the upper/lower limit of the page.
boolean	scrollTo(Control control) Overloaded scrollTo(Control, ScrollTo) method which looks for control by scrolling to the top of the screen first and then to the bottom.
boolean	scrollTo(Control control, boolean up) Swipes screen till specific control appears.
boolean	scrollTo(Control control, ScrollTo scrollDirection) Swipes screen till specific control appears.
boolean	scrollTo(java.lang.String text) Overloaded scrollTo(String, ScrollTo) method which looks for text by scrolling to the top of the screen first and then to the bottom.
boolean	scrollTo(java.lang.String text, boolean up) Swipes screen till specific text appears.
boolean	scrollTo(java.lang.String text, ScrollTo scrollDirection) Swipes screen till specific text appears.
Page	section(java.lang.String name) Looks for nested page object by specific name.
<T extends Page> T	section(java.lang.String name, java.lang.Class<T> pageType) Looks for nested page object by specific name.
static void	setCurrent(Page newPage) Sets the current page for current thread instance.
static void	setDefaultPagesPackage(java.lang.String defaultPagesPackageValue) Sets package name which is used as the root package for all page classes in the entire solution.
static void	setTimeout(int timeoutValue) Assigns new timeout value.
boolean	swipeScreen(boolean vertical, boolean leftTop, boolean once) Overloaded version of swipeScreen(boolean, boolean, boolean, int) where the scrolling time is set to 2 seconds.
boolean	swipeScreen(boolean vertical, boolean leftTop, boolean once, int seconds) Performs scrolling operation which scrolls to the size of visible screen.
Page	switchTo() Method responsible for switching to frame/window represented by current page object.
Page	verify(Operation<java.lang.Boolean,Page> predicate) Verifies that page has some specific state and asserts the error if condition is not met.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Page

public Page(org.openqa.selenium.WebDriver driverValue)

Default constructor which binds the WebDriver instance to the Page abstractions. This constructor should be available in all extended classes especially when page object initialization is done via PageFactory.init(WebDriver, Class) call.

Parameters:

driverValue - the actual WebDriver instance.

Method Detail

getTimeout

public static int getTimeout()

Returns the timeout value which is currently set. This is explicit waiting timeout which is used to wait for some event to happen.

Returns:

currently set timeout.

setTimeout

public static void setTimeout(int timeoutValue)

Assigns new timeout value.

Parameters:

timeoutValue - new timeout value.

getDefaultPagesPackage

public static java.lang.String getDefaultPagesPackage()

Returns package name which is used as the root package for all page classes in the entire solution. Such package customisation is needed for forName(String) method to minimise search time as the entire solution may appear to be big.

Returns:

root package for page classes.

setDefaultPagesPackage

public static void setDefaultPagesPackage(java.lang.String defaultPagesPackageValue)

Sets package name which is used as the root package for all page classes in the entire solution. Such package customisation is needed for forName(String) method to minimise search time as the entire solution may appear to be big.

Parameters:

defaultPagesPackageValue - root package for page classes.

forName

public static Page forName(java.lang.String name)
                    throws java.lang.Exception

Retrieves page object by it's logical name specified as the value of Alias annotation. This is overloaded version of the forName(String, String) method where the pages package name is retrieved from locally stored static variable by means of getDefaultPagesPackage() call.

Parameters:

name - the logical name of the page class to retrieve instance of.

Returns:

the page class which alias matches the name paremeter.

Throws:

java.lang.Exception - any exception related to data conversion or null value.

See Also:

Alias

forName

public static Page forName(java.lang.String name,
                           java.lang.String pagePackage)
                    throws java.lang.Exception

Retrieves page object by it's logical name specified as the value of Alias annotation. Mainly, it searches for classes extended from Page class inside the package specified by pagePackage parameter.

Parameters:

name - the logical name of the page class to retrieve instance of.

pagePackage - the package to search page classes in.

Returns:

the page class which alias matches the name paremeter.

Throws:

java.lang.Exception - any exception related to data conversion or null value.

See Also:

forName(String), Alias

getCurrent

public static Page getCurrent()

Gets the current page for current thread instance.

Returns:

the Page object for current page.

setCurrent

public static void setCurrent(Page newPage)

Sets the current page for current thread instance.

Parameters:

newPage - the Page object for current page.

getCurrentFromList

public static Page getCurrentFromList(java.lang.Class<? extends Page>[] pageClasses,
                                      int tries)
                               throws java.lang.Exception

Checks multiple page classes in order to identify which of the classes proposed fit the current page. For each page class the Page#isCurrent() method is called. If for any page class the return value is true the instance of this class is created and returned.

If none of proposed classes matches current page state the new iteration starts.

If nothing is found after specified iteration limit the null value is returned.

Parameters:

pageClasses - the list of page classes to look in.

tries - the number of iterations

Returns:

the Page instance for the current page found or null if none of proposed page classes fits the current state.

Throws:

java.lang.Exception - any class conversion or null pointer exception.

See Also:

Page#isCurrent()}

getCurrentFromList

public static Page getCurrentFromList(java.lang.Class<? extends Page>[] pageClasses,
                                      int tries,
                                      boolean useCache)
                               throws java.lang.Exception

Checks multiple page classes in order to identify which of the classes proposed fit the current page. For each page class the Page#isCurrent() method is called. If for any page class the return value is true the instance of this class is created and returned.

If none of proposed classes matches current page state the new iteration starts.

If nothing is found after specified iteration limit the null value is returned.

Parameters:

pageClasses - the list of page classes to look in.

tries - the number of iterations.

useCache - (not in use at the moment) the flag identifying whether method should use cached source for verifications prior to applying to application under test directly.

Returns:

the Page instance for the current page found or null if none of proposed page classes fits the current state.

Throws:

java.lang.Exception - any class conversion or null pointer exception.

See Also:

Page#isCurrent()}

getFirstAvailableControlFromList

public static Control getFirstAvailableControlFromList(Control[] controls,
                                                       int tries)
                                                throws java.lang.Exception

Goes through the list of proposed controls and returns the first one which appears.

Parameters:

controls - the list of controls to look for first available in.

tries - the limit of tries (similar to the timeout).

Returns:

the first control object which appears to be existing.

Throws:

java.lang.Exception - any assertion or data conversion errors.

getDriver

public org.openqa.selenium.WebDriver getDriver()

Gets the actual WebDriver object if some WebDriver API is needed directly.

Returns:

the actual WebDriver object.

navigate

public Page navigate()
              throws java.lang.Exception

Performs actions to navigate to current page. By default it does nothing. But any extended class can override this method and perform actual actions which result with specific page instance to appear.

This method is actively used by PageSteps#navigateToPage(String) method as well as associated Cucumber-JVM keywords:

 Given I am on the "<Page Name>" page
 

or

 When I go to the "<Page Name>" page
 

The idea is that for any page classes which can be used for such navigation operation the navigate method is overridden to implement actual navigation behaviour. This way the same implementation can be applied for all page classes which can be navigated to.

Returns:

the object corresponding to the page which should be current.

Throws:

java.lang.Exception - any assertion or other exception which appears during page navigation processing.

isTextPresent

public boolean isTextPresent(java.lang.String text)

Checks if some text is available on current page. In a number of cases we just need to check that some labels are available or some text is shown. It's too expensive to reserve dedicated field for each of such elements. But in order to make such check widely used the isTextPresent method gets such element dynamically and waits for element to appear.

Parameters:

text - the text value to wait for.

Returns:

true - the text label is available on screen, false - otherwise.

captureScreenShot

public byte[] captureScreenShot()
                         throws java.io.IOException

Captures the screenshot of current page.

Returns:

The byte array containing image data.

Throws:

java.io.IOException - I/O problems while retrieving the image data.

captureScreenShot

public java.io.File captureScreenShot(java.lang.String destination)
                               throws java.io.IOException

Captures the screenshot of current page and stores it in the file.

Parameters:

destination - the destination path of the screenshot.

Returns:

the File object referencing to generated file.

Throws:

java.io.IOException - I/O problems.

getSource

public java.lang.String getSource()

Gets the page source code. Usually it is page HTML (for web) or at least some XML representation (for WebDriver implementation for other platforms).

Returns:

current page source.

getScrollable

public Control getScrollable()

Returns element which is available for scrolling. By default, it's first scrollable element.

NOTE: currently, it is applicable for Android platform only.

Returns:

control object which can be used for scrolling.

getTextControl

public Control getTextControl(java.lang.String message)

Dynamically generates control object which corresponds to the element containing text specified by the parameter.

Parameters:

message - the text the control should contain.

Returns:

the control with the text containing specified message parameter.

See Also:

isTextPresent(String)

swipeScreen

public boolean swipeScreen(boolean vertical,
                           boolean leftTop,
                           boolean once)

Overloaded version of swipeScreen(boolean, boolean, boolean, int) where the scrolling time is set to 2 seconds.

Parameters:

vertical - flag indicating if scroll should be vertical. If false, the scrolling is horizontal.

leftTop - the direction of scrolling. If true, the scroll will be performed to the left or top depending on the vertical flag.

once - flag identifying whether scrolling should be done once or until the end of the page is reached (if false).

Returns:

true is scrolling was completed. If false, the operation cannot be performed due to scrollable element unavailability.

See Also:

swipeScreen(boolean, boolean, boolean, int)

swipeScreen

public boolean swipeScreen(boolean vertical,
                           boolean leftTop,
                           boolean once,
                           int seconds)

Performs scrolling operation which scrolls to the size of visible screen. This is the most common method for such operation and it also controls whether we should perform vertical/horizontal scrolling as well as the direction (left-to-right, top-bottom or vice versa).

Additionally it controls the number of swipe operations. Method performs scrolling wither till the end of the page or just once. This is controlled by dedicated flag.

NOTE: applicable for Android only.

Parameters:

vertical - flag indicating if scroll should be vertical. If false, the scrolling is horizontal.

leftTop - the direction of scrolling. If true, the scroll will be performed to the left or top depending on the vertical flag.

once - flag identifying whether scrolling should be done once or until the end of the page is reached (if false).

seconds - the number of seconds for scrolling operation.

Returns:

true is scrolling was completed. If false, the operation cannot be performed due to scrollable element unavailability.

scrollTo

public boolean scrollTo(Control control,
                        boolean up)

Swipes screen till specific control appears.

NOTE: applicable for Android only.

Parameters:

control - the control object to scroll to.

up - flag identifying if scrolling should be done into top.

Returns:

if true, the control to scroll to is now visible on the screen. False - otherwise.

scrollTo

public boolean scrollTo(boolean up)
                 throws java.lang.Exception

Swipes screen to the upper/lower limit of the page.

NOTE: applicable for Android only.

Parameters:

up - flag identifying if scrolling should be performed to the top (if true) or the bottom (if false) of the page.

Returns:

true is scrolling was completed. If false, the operation cannot be performed due to scrollable element unavailability.

Throws:

java.lang.Exception - any assertion or other exception which can happen during operaiton.

scrollTo

public boolean scrollTo(Control control,
                        ScrollTo scrollDirection)

Swipes screen till specific control appears. Unlike scrollTo(Control, boolean) method, this method defines general trajectory of scrolling. E.g. we may search for specific control either by scrolling only to top/bottom of the screen or we may define that we should swipe to the top first and then to the bottom.

NOTE: applicable for Android only.

Parameters:

control - the control object to scroll to.

scrollDirection - general trajectory to search for specified element. Please, refer to the ScrollTo enumeration description.

Returns:

if true, the control to scroll to is now visible on the screen. False - otherwise.

See Also:

ScrollTo

scrollTo

public boolean scrollTo(Control control)

Overloaded scrollTo(Control, ScrollTo) method which looks for control by scrolling to the top of the screen first and then to the bottom.

Parameters:

control - the control object to scroll to.

Returns:

if true, the control to scroll to is now visible on the screen. False - otherwise.

scrollTo

public boolean scrollTo(java.lang.String text,
                        boolean up)

Swipes screen till specific text appears.

NOTE: applicable for Android only.

Parameters:

text - the text to scroll to.

up - flag identifying if scrolling should be done into top.

Returns:

if true, the text to scroll to is now visible on the screen. False - otherwise.

scrollTo

public boolean scrollTo(java.lang.String text,
                        ScrollTo scrollDirection)

Swipes screen till specific text appears. Unlike scrollTo(String, boolean) method, this method defines general trajectory of scrolling. E.g. we may search for specific control either by scrolling only to top/bottom of the screen or we may define that we should swipe to the top first and then to the bottom.

NOTE: applicable for Android only.

Parameters:

text - the text to scroll to.

scrollDirection - general trajectory to search for specified element. Please, refer to the ScrollTo enumeration description.

Returns:

if true, the text to scroll to is now visible on the screen. False - otherwise.

See Also:

ScrollTo

scrollTo

public boolean scrollTo(java.lang.String text)

Overloaded scrollTo(String, ScrollTo) method which looks for text by scrolling to the top of the screen first and then to the bottom.

Parameters:

text - the text to scroll to.

Returns:

if true, the text to scroll to is now visible on the screen. False - otherwise.

hideKeyboard

public void hideKeyboard()

Forcibly hides the virtual keyboard.

NOTE: applicable for Android only.

allOf

public boolean allOf(Control[] elements,
                     Operation<java.lang.Boolean,Control> predicate)

Checks if all elements passed as the parameter have the state specified by predicate.

Parameters:

elements - the list of elements to check.

predicate - the condition to check against.

Returns:

true if all elements met condition. False - otherwise.

anyOf

public boolean anyOf(Control[] elements,
                     Operation<java.lang.Boolean,Control> predicate)

Checks if any of elements passed as the parameter has the state specified by predicate.

Parameters:

elements - the list of elements to check.

predicate - the condition to check against.

Returns:

true if any of elements met condition. False - otherwise.

field

public Control field(java.lang.String name)
              throws java.lang.Exception

Gets the current page class control with logical name specified.

Mainly it goes through all fields of current page class and checks only fields which are of Control class or any extended classes. For each of such control objects the method gets the Alias annotation and gets it value.

If this value equals the name specified as the parameter the corresponding control is returned.

Parameters:

name - the logical name of the control to get from current page object.

Returns:

the control corresponding to the logical name passed as the parameter or null if no such element found.

Throws:

java.lang.Exception - either reflection problems (like access) or missing attributes.

See Also:

Alias

field

public <T extends Control> T field(java.lang.String name,
                                   java.lang.Class<T> controlType)
                            throws java.lang.Exception

Gets the current page class control with logical name specified.

Mainly it goes through all fields of current page class and checks only fields which are of Control class or any extended classes. For each of such control objects the method gets the Alias annotation and gets it value.

If this value equals the name specified as the parameter the corresponding control is returned.

Type Parameters:

T - the type of returning control.

Parameters:

name - the logical name of the control to get from current page object.

controlType - the type of returning control.

Returns:

the control corresponding to the logical name passed as the parameter or null if no such element found.

Throws:

java.lang.Exception - either reflection problems (like access) or missing attributes.

See Also:

Alias

section

public Page section(java.lang.String name)
             throws java.lang.Exception

Looks for nested page object by specific name.

Parameters:

name - the name of the sub-page to return.

Returns:

the instance of the page found.

Throws:

java.lang.Exception - any reflection related exceptions.

section

public <T extends Page> T section(java.lang.String name,
                                  java.lang.Class<T> pageType)
                           throws java.lang.Exception

Looks for nested page object by specific name.

Type Parameters:

T - the expected page class.

Parameters:

name - the name of the sub-page to return.

pageType - the target page object class.

Returns:

the instance of the page found.

Throws:

java.lang.Exception - any reflection related exceptions.

switchTo

public Page switchTo()

Method responsible for switching to frame/window represented by current page object. Usually, it does nothing but if alias declares index or some form of id, it is used to locate the the frame or new window.

Returns:

current page object.

is

public boolean is(Operation<java.lang.Boolean,Page> predicate)

Checks some state of page depending on predicate specified.

Parameters:

predicate - Operation expression returning boolean state value.

Returns:

true if condition is met, false - otherwise.

verify

public Page verify(Operation<java.lang.Boolean,Page> predicate)

Verifies that page has some specific state and asserts the error if condition is not met.

Parameters:

predicate - Operation expression returning boolean state value.

Returns:

current control.