net.sourceforge.jbizmo.commons.selenium.page.imp.primefaces

Class AbstractPageObject

java.lang.Object

net.sourceforge.jbizmo.commons.selenium.page.AbstractPageComponent

net.sourceforge.jbizmo.commons.selenium.page.imp.primefaces.AbstractPrimefacesPageComponent

net.sourceforge.jbizmo.commons.selenium.page.imp.primefaces.AbstractPageObject

Direct Known Subclasses:

AbstractViewPageObject

public abstract class AbstractPageObject
extends AbstractPrimefacesPageComponent

Abstract base class for all page objects of a Primefaces application

Copyright 2017 (C) by Martin Ganserer

Version:

1.0.0

Author:

Martin Ganserer

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUTTON_ID_LOG_IN
static String	FORM_ID_PREFIX

Fields inherited from class net.sourceforge.jbizmo.commons.selenium.page.AbstractPageComponent

AJAX_POLLING_INTERVAL_MILLISECONDS, ATTR_NAME_CLASS, ATTR_NAME_SELECTED, ATTR_NAME_STYLE, ATTR_NAME_VALUE, driver, HTML_LIST_ITEM, ITEM_DELIMITER, logger, NEW_LINE, ROW_OFFSET_X, ROW_OFFSET_Y, testContext

Constructor Summary

Constructors

Constructor and Description
AbstractPageObject(SeleniumTestContext testContext) Constructor

Method Summary

Modifier and Type	Method and Description
protected String	buildPageURL(String baseURL, String resourcePath) Build the page URL using the given base URL and a resource path.
protected boolean	getCheckBoxSelection(PageElementTestData testData) Determine the selection of a checkbox field
void	open(String resourcePath) Open a page
void	open(String resourcePath, String objectId) Open a page to display data for a specific object identified by the given ID
<T extends AbstractPageObject> T	openPageByNavigator(String navigationTarget, Class<T> pageClass) Navigate to a page by selecting a tree view item with the specified navigation target! As the page object is created via introspection it is necessary that the respective class provides an appropriate constructor!
void	openTabPage(String tabPageId) Open a tab page identified by the given ID
void	pressBackButton() Press the 'Back' button
void	pressButton(String id) Press a button with a given ID
void	pressLogoutButton() Press the logout button
void	pressSaveButton() Press the 'Save' button
<T extends AbstractPageObject> T	pressSaveButton(Class<T> pageClass) Press the 'Save' button
void	selectAutoCompleteItem(PageElementTestData testData) Select an item of an auto-complete field
void	selectComboboxItem(PageElementTestData testData) Select an item of a combobox field
protected boolean	selectItem(org.openqa.selenium.WebElement element, String itemValue) Search for an existing list item with the given value and select it
void	selectLoVItem(PageElementTestData testData) Select an item by opening a list-of-values in a pop-up window
void	setCheckBoxValue(PageElementTestData testData) Change the selection of a checkbox
void	uploadFile(String dialogId, PageElementTestData testData) Upload a file in a pop-up window
void	validateAutoCompleteItem(PageElementTestData testData) Validate the selected item of an auto-complete field
void	validateCheckBoxValue(PageElementTestData testData) Validate the selection of a checkbox field
void	validateComboboxItem(PageElementTestData testData) Validate the selected item of a combobox field
void	validateLabelText(PageElementTestData testData) Validate a label field by using the field's test data object
void	validateLoVItem(PageElementTestData testData) Validate the selected item of a list-of-values field
void	validatePageTitle(PageElementTestData testData) Compare the page title with the expected text provided by the test data object
MessageDialog	waitForMessageDialog(PageActionResult actionResult) Wait for a message dialog and perform a status validation check
void	waitForNotificationMessage(PageActionResult actionResult) Wait for a growl notification message and perform a status validation check

Methods inherited from class net.sourceforge.jbizmo.commons.selenium.page.imp.primefaces.AbstractPrimefacesPageComponent

createPageObject, waitForPendingAjaxRequests

Methods inherited from class net.sourceforge.jbizmo.commons.selenium.page.AbstractPageComponent

assertEquals, assertNotNull, assertTrue, delayPageLoad, doubleClickElement, fail, fail, findWebElement, findWebElement, findWebElementByXPath, findWebElementsByXPath, getDriver, getLogger, getTestContext, moveToElement, scrollTo, setInputFieldValue, setLogger, validateInputFieldValue, waitUntilVisible

Methods inherited from class java.lang.Object

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

Field Detail

FORM_ID_PREFIX

public static final String FORM_ID_PREFIX

See Also:

Constant Field Values

BUTTON_ID_LOG_IN

public static final String BUTTON_ID_LOG_IN

See Also:

Constant Field Values

Constructor Detail

AbstractPageObject

public AbstractPageObject(SeleniumTestContext testContext)

Constructor

Parameters:

testContext -

Method Detail

open

public void open(String resourcePath)

Open a page

Parameters:

resourcePath -

Throws:

AssertionError - if the parameter is null

open

public void open(String resourcePath,
                 String objectId)

Open a page to display data for a specific object identified by the given ID

Parameters:

resourcePath -

objectId -

Throws:

AssertionError - if the parameter is null

openPageByNavigator

public <T extends AbstractPageObject> T openPageByNavigator(String navigationTarget,
                                                            Class<T> pageClass)

Navigate to a page by selecting a tree view item with the specified navigation target! As the page object is created via introspection it is necessary that the respective class provides an appropriate constructor!

Type Parameters:

T - the type of the page object that should be returned

Parameters:

navigationTarget -

pageClass -

Returns:

a page instance whose type is defined by the respective parameter

Throws:

AssertionError - if the operation has failed

pressLogoutButton

public void pressLogoutButton()

Press the logout button

Throws:

AssertionError - if the button could not be found

pressSaveButton

public void pressSaveButton()

Press the 'Save' button

Throws:

AssertionError - if the button could not be found

pressSaveButton

public <T extends AbstractPageObject> T pressSaveButton(Class<T> pageClass)

Press the 'Save' button

Type Parameters:

T - the type of the page object that should be returned

Parameters:

pageClass -

Returns:

a page instance whose type is defined by the respective parameter

Throws:

AssertionError - if the button either could not be found, or the page object could not be created

pressBackButton

public void pressBackButton()

Press the 'Back' button

Throws:

AssertionError - if the button could not be found

pressButton

public void pressButton(String id)

Press a button with a given ID

Parameters:

id -

Throws:

AssertionError - if the button could not be found

setCheckBoxValue

public void setCheckBoxValue(PageElementTestData testData)

Change the selection of a checkbox

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if changing of the checkbox selection has failed

validateCheckBoxValue

public void validateCheckBoxValue(PageElementTestData testData)

Validate the selection of a checkbox field

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if the validation has failed

selectAutoCompleteItem

public void selectAutoCompleteItem(PageElementTestData testData)

Select an item of an auto-complete field

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if an item could not be selected

validateAutoCompleteItem

public void validateAutoCompleteItem(PageElementTestData testData)

Validate the selected item of an auto-complete field

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if the validation has failed

selectComboboxItem

public void selectComboboxItem(PageElementTestData testData)

Select an item of a combobox field

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if an item could not be selected

validateComboboxItem

public void validateComboboxItem(PageElementTestData testData)

Validate the selected item of a combobox field

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if the validation has failed

selectLoVItem

public void selectLoVItem(PageElementTestData testData)

Select an item by opening a list-of-values in a pop-up window

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if an item could not be selected

validateLoVItem

public void validateLoVItem(PageElementTestData testData)

Validate the selected item of a list-of-values field

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if the validation has failed

validateLabelText

public void validateLabelText(PageElementTestData testData)

Validate a label field by using the field's test data object

Parameters:

testData - the field's test data object that provides necessary information

Throws:

AssertionError - if the validation has failed

uploadFile

public void uploadFile(String dialogId,
                       PageElementTestData testData)

Upload a file in a pop-up window

Parameters:

dialogId - the ID of the pop-up window

testData - the test data object that provides necessary information

Throws:

AssertionError - if an element either could not be found, or test data is invalid

openTabPage

public void openTabPage(String tabPageId)

Open a tab page identified by the given ID

Parameters:

tabPageId -

Throws:

AssertionError - if the tab page could not be found

waitForMessageDialog

public MessageDialog waitForMessageDialog(PageActionResult actionResult)

Wait for a message dialog and perform a status validation check

Parameters:

actionResult -

Returns:

a message dialog

Throws:

AssertionError - if the status validation either has failed, or an element could not be found

waitForNotificationMessage

public void waitForNotificationMessage(PageActionResult actionResult)

Wait for a growl notification message and perform a status validation check

Parameters:

actionResult -

Throws:

AssertionError - if the status validation either has failed, or an element could not be found

validatePageTitle

public void validatePageTitle(PageElementTestData testData)

Compare the page title with the expected text provided by the test data object

Parameters:

testData - the test data object that provides necessary information

Throws:

AssertionError - if the validation either has failed, or the test data is invalid

selectItem

protected boolean selectItem(org.openqa.selenium.WebElement element,
                             String itemValue)

Search for an existing list item with the given value and select it

Parameters:

element -

itemValue -

Returns:

true if an item could be selected

getCheckBoxSelection

protected boolean getCheckBoxSelection(PageElementTestData testData)

Determine the selection of a checkbox field

Parameters:

testData - the field's test data object that provides necessary information

Returns:

true if the checkbox is selected

buildPageURL

protected String buildPageURL(String baseURL,
                              String resourcePath)

Build the page URL using the given base URL and a resource path. If necessary, both strings will be joined by using a '/' character!

Parameters:

baseURL -

resourcePath -

Returns:

the URL